diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AcceptedSentSharesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AcceptedSentSharesClient.cs new file mode 100644 index 000000000000..b9ef658e830d --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AcceptedSentSharesClient.cs @@ -0,0 +1,499 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The AcceptedSentShares service client. + /// The AcceptedSentShares service client. + public partial class AcceptedSentSharesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of AcceptedSentSharesClient for mocking. + protected AcceptedSentSharesClient() + { + } + + /// Initializes a new instance of AcceptedSentSharesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public AcceptedSentSharesClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of AcceptedSentSharesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public AcceptedSentSharesClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get an accepted share with acceptedSentShareName to a particular sent share. + /// The name of the sent share. + /// The name of the accepted sent share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetAcceptedSentShareAsync(string sentShareName, string acceptedSentShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.GetAcceptedSentShare"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAcceptedSentShareRequest(sentShareName, acceptedSentShareName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get an accepted share with acceptedSentShareName to a particular sent share. + /// The name of the sent share. + /// The name of the accepted sent share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetAcceptedSentShare(string sentShareName, string acceptedSentShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.GetAcceptedSentShare"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAcceptedSentShareRequest(sentShareName, acceptedSentShareName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List of accepted shares for the current sent share. + /// The name of the sent share. + /// The continuation token to list the next page. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetAcceptedSentSharesAsync(string sentShareName, string skipToken = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + return GetAcceptedSentSharesImplementationAsync("AcceptedSentSharesClient.GetAcceptedSentShares", sentShareName, skipToken, context); + } + + private AsyncPageable GetAcceptedSentSharesImplementationAsync(string diagnosticsScopeName, string sentShareName, string skipToken, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetAcceptedSentSharesRequest(sentShareName, skipToken, context) + : CreateGetAcceptedSentSharesNextPageRequest(nextLink, sentShareName, skipToken, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List of accepted shares for the current sent share. + /// The name of the sent share. + /// The continuation token to list the next page. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetAcceptedSentShares(string sentShareName, string skipToken = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + return GetAcceptedSentSharesImplementation("AcceptedSentSharesClient.GetAcceptedSentShares", sentShareName, skipToken, context); + } + + private Pageable GetAcceptedSentSharesImplementation(string diagnosticsScopeName, string sentShareName, string skipToken, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetAcceptedSentSharesRequest(sentShareName, skipToken, context) + : CreateGetAcceptedSentSharesNextPageRequest(nextLink, sentShareName, skipToken, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Reinstate a revoked accepted sent share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the accepted sent share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual async Task> ReinstateAsync(WaitUntil waitUntil, string sentShareName, string acceptedSentShareName, RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.Reinstate"); + scope.Start(); + try + { + using HttpMessage message = CreateReinstateRequest(sentShareName, acceptedSentShareName, content, repeatabilityRequestId, context); + return await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "AcceptedSentSharesClient.Reinstate", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Reinstate a revoked accepted sent share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the accepted sent share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual Operation Reinstate(WaitUntil waitUntil, string sentShareName, string acceptedSentShareName, RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.Reinstate"); + scope.Start(); + try + { + using HttpMessage message = CreateReinstateRequest(sentShareName, acceptedSentShareName, content, repeatabilityRequestId, context); + return ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "AcceptedSentSharesClient.Reinstate", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Revoke an accepted sent share's access. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the accepted sent share. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual async Task> RevokeAsync(WaitUntil waitUntil, string sentShareName, string acceptedSentShareName, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.Revoke"); + scope.Start(); + try + { + using HttpMessage message = CreateRevokeRequest(sentShareName, acceptedSentShareName, repeatabilityRequestId, context); + return await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "AcceptedSentSharesClient.Revoke", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Revoke an accepted sent share's access. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the accepted sent share. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual Operation Revoke(WaitUntil waitUntil, string sentShareName, string acceptedSentShareName, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.Revoke"); + scope.Start(); + try + { + using HttpMessage message = CreateRevokeRequest(sentShareName, acceptedSentShareName, repeatabilityRequestId, context); + return ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "AcceptedSentSharesClient.Revoke", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the expiration date of an active accepted sent share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the accepted sent share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual async Task> UpdateExpirationAsync(WaitUntil waitUntil, string sentShareName, string acceptedSentShareName, RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.UpdateExpiration"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateExpirationRequest(sentShareName, acceptedSentShareName, content, repeatabilityRequestId, context); + return await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "AcceptedSentSharesClient.UpdateExpiration", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the expiration date of an active accepted sent share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the accepted sent share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual Operation UpdateExpiration(WaitUntil waitUntil, string sentShareName, string acceptedSentShareName, RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(acceptedSentShareName, nameof(acceptedSentShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AcceptedSentSharesClient.UpdateExpiration"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateExpirationRequest(sentShareName, acceptedSentShareName, content, repeatabilityRequestId, context); + return ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "AcceptedSentSharesClient.UpdateExpiration", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetAcceptedSentSharesRequest(string sentShareName, string skipToken, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/acceptedSentShares", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetAcceptedSentShareRequest(string sentShareName, string acceptedSentShareName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/acceptedSentShares/", false); + uri.AppendPath(acceptedSentShareName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateReinstateRequest(string sentShareName, string acceptedSentShareName, RequestContent content, string repeatabilityRequestId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/acceptedSentShares/", false); + uri.AppendPath(acceptedSentShareName, true); + uri.AppendPath(":reinstate", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + if (repeatabilityRequestId != null) + { + request.Headers.Add("repeatability-request-id", repeatabilityRequestId); + } + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateRevokeRequest(string sentShareName, string acceptedSentShareName, string repeatabilityRequestId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/acceptedSentShares/", false); + uri.AppendPath(acceptedSentShareName, true); + uri.AppendPath(":revoke", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + if (repeatabilityRequestId != null) + { + request.Headers.Add("repeatability-request-id", repeatabilityRequestId); + } + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateUpdateExpirationRequest(string sentShareName, string acceptedSentShareName, RequestContent content, string repeatabilityRequestId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/acceptedSentShares/", false); + uri.AppendPath(acceptedSentShareName, true); + uri.AppendPath(":update-expiration", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + if (repeatabilityRequestId != null) + { + request.Headers.Add("repeatability-request-id", repeatabilityRequestId); + } + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetAcceptedSentSharesNextPageRequest(string nextLink, string sentShareName, string skipToken, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AssetMappingsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AssetMappingsClient.cs new file mode 100644 index 000000000000..38216bdbeee8 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AssetMappingsClient.cs @@ -0,0 +1,411 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The AssetMappings service client. + /// The AssetMappings service client. + public partial class AssetMappingsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of AssetMappingsClient for mocking. + protected AssetMappingsClient() + { + } + + /// Initializes a new instance of AssetMappingsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public AssetMappingsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of AssetMappingsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public AssetMappingsClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get AssetMapping in a receivedShare. + /// The name of the received share. + /// The name of the asset mapping. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetAssetMappingAsync(string receivedShareName, string assetMappingName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNullOrEmpty(assetMappingName, nameof(assetMappingName)); + + using var scope = ClientDiagnostics.CreateScope("AssetMappingsClient.GetAssetMapping"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAssetMappingRequest(receivedShareName, assetMappingName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get AssetMapping in a receivedShare. + /// The name of the received share. + /// The name of the asset mapping. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetAssetMapping(string receivedShareName, string assetMappingName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNullOrEmpty(assetMappingName, nameof(assetMappingName)); + + using var scope = ClientDiagnostics.CreateScope("AssetMappingsClient.GetAssetMapping"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAssetMappingRequest(receivedShareName, assetMappingName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List AssetMappings in a received share. + /// The name of the received share. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetAssetMappingsAsync(string receivedShareName, string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + return GetAssetMappingsImplementationAsync("AssetMappingsClient.GetAssetMappings", receivedShareName, skipToken, filter, orderby, context); + } + + private AsyncPageable GetAssetMappingsImplementationAsync(string diagnosticsScopeName, string receivedShareName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetAssetMappingsRequest(receivedShareName, skipToken, filter, orderby, context) + : CreateGetAssetMappingsNextPageRequest(nextLink, receivedShareName, skipToken, filter, orderby, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List AssetMappings in a received share. + /// The name of the received share. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetAssetMappings(string receivedShareName, string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + return GetAssetMappingsImplementation("AssetMappingsClient.GetAssetMappings", receivedShareName, skipToken, filter, orderby, context); + } + + private Pageable GetAssetMappingsImplementation(string diagnosticsScopeName, string receivedShareName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetAssetMappingsRequest(receivedShareName, skipToken, filter, orderby, context) + : CreateGetAssetMappingsNextPageRequest(nextLink, receivedShareName, skipToken, filter, orderby, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Maps a source asset in the sent share to a destination asset in the received share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the received share. + /// The name of the asset mapping. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual async Task> CreateAsync(WaitUntil waitUntil, string receivedShareName, string assetMappingName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNullOrEmpty(assetMappingName, nameof(assetMappingName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AssetMappingsClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(receivedShareName, assetMappingName, content, context); + return await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "AssetMappingsClient.Create", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Maps a source asset in the sent share to a destination asset in the received share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the received share. + /// The name of the asset mapping. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual Operation Create(WaitUntil waitUntil, string receivedShareName, string assetMappingName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNullOrEmpty(assetMappingName, nameof(assetMappingName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AssetMappingsClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(receivedShareName, assetMappingName, content, context); + return ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "AssetMappingsClient.Create", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete AssetMapping in a receivedShare. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the received share. + /// The name of the asset mapping. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual async Task DeleteAsync(WaitUntil waitUntil, string receivedShareName, string assetMappingName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNullOrEmpty(assetMappingName, nameof(assetMappingName)); + + using var scope = ClientDiagnostics.CreateScope("AssetMappingsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(receivedShareName, assetMappingName, context); + return await ProtocolOperationHelpers.ProcessMessageWithoutResponseValueAsync(_pipeline, message, ClientDiagnostics, "AssetMappingsClient.Delete", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete AssetMapping in a receivedShare. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the received share. + /// The name of the asset mapping. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual Operation Delete(WaitUntil waitUntil, string receivedShareName, string assetMappingName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNullOrEmpty(assetMappingName, nameof(assetMappingName)); + + using var scope = ClientDiagnostics.CreateScope("AssetMappingsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(receivedShareName, assetMappingName, context); + return ProtocolOperationHelpers.ProcessMessageWithoutResponseValue(_pipeline, message, ClientDiagnostics, "AssetMappingsClient.Delete", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetAssetMappingsRequest(string receivedShareName, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendPath("/assetMappings", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (orderby != null) + { + uri.AppendQuery("$orderby", orderby, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetAssetMappingRequest(string receivedShareName, string assetMappingName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendPath("/assetMappings/", false); + uri.AppendPath(assetMappingName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(string receivedShareName, string assetMappingName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200202); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendPath("/assetMappings/", false); + uri.AppendPath(assetMappingName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string receivedShareName, string assetMappingName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendPath("/assetMappings/", false); + uri.AppendPath(assetMappingName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetAssetMappingsNextPageRequest(string nextLink, string receivedShareName, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200202; + private static ResponseClassifier ResponseClassifier200202 => _responseClassifier200202 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 202 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AssetsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AssetsClient.cs new file mode 100644 index 000000000000..954be558965b --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/AssetsClient.cs @@ -0,0 +1,409 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Assets service client. + /// The Assets service client. + public partial class AssetsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of AssetsClient for mocking. + protected AssetsClient() + { + } + + /// Initializes a new instance of AssetsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public AssetsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of AssetsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public AssetsClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get asset in a sentShare. + /// The name of the sent share. + /// The name of the asset. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetAssetAsync(string sentShareName, string assetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(assetName, nameof(assetName)); + + using var scope = ClientDiagnostics.CreateScope("AssetsClient.GetAsset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAssetRequest(sentShareName, assetName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get asset in a sentShare. + /// The name of the sent share. + /// The name of the asset. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetAsset(string sentShareName, string assetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(assetName, nameof(assetName)); + + using var scope = ClientDiagnostics.CreateScope("AssetsClient.GetAsset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAssetRequest(sentShareName, assetName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List Assets in a share. + /// The name of the sent share. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetAssetsAsync(string sentShareName, string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + return GetAssetsImplementationAsync("AssetsClient.GetAssets", sentShareName, skipToken, filter, orderby, context); + } + + private AsyncPageable GetAssetsImplementationAsync(string diagnosticsScopeName, string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetAssetsRequest(sentShareName, skipToken, filter, orderby, context) + : CreateGetAssetsNextPageRequest(nextLink, sentShareName, skipToken, filter, orderby, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List Assets in a share. + /// The name of the sent share. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetAssets(string sentShareName, string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + return GetAssetsImplementation("AssetsClient.GetAssets", sentShareName, skipToken, filter, orderby, context); + } + + private Pageable GetAssetsImplementation(string diagnosticsScopeName, string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetAssetsRequest(sentShareName, skipToken, filter, orderby, context) + : CreateGetAssetsNextPageRequest(nextLink, sentShareName, skipToken, filter, orderby, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Adds a new asset to an existing share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the asset. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual async Task> CreateAsync(WaitUntil waitUntil, string sentShareName, string assetName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(assetName, nameof(assetName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AssetsClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(sentShareName, assetName, content, context); + return await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "AssetsClient.Create", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Adds a new asset to an existing share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the asset. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual Operation Create(WaitUntil waitUntil, string sentShareName, string assetName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(assetName, nameof(assetName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("AssetsClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(sentShareName, assetName, content, context); + return ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "AssetsClient.Create", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete asset in a sentShare. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the asset. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual async Task DeleteAsync(WaitUntil waitUntil, string sentShareName, string assetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(assetName, nameof(assetName)); + + using var scope = ClientDiagnostics.CreateScope("AssetsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(sentShareName, assetName, context); + return await ProtocolOperationHelpers.ProcessMessageWithoutResponseValueAsync(_pipeline, message, ClientDiagnostics, "AssetsClient.Delete", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete asset in a sentShare. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The name of the asset. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual Operation Delete(WaitUntil waitUntil, string sentShareName, string assetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(assetName, nameof(assetName)); + + using var scope = ClientDiagnostics.CreateScope("AssetsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(sentShareName, assetName, context); + return ProtocolOperationHelpers.ProcessMessageWithoutResponseValue(_pipeline, message, ClientDiagnostics, "AssetsClient.Delete", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetAssetsRequest(string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/assets", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (orderby != null) + { + uri.AppendQuery("$orderby", orderby, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetAssetRequest(string sentShareName, string assetName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/assets/", false); + uri.AppendPath(assetName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(string sentShareName, string assetName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/assets/", false); + uri.AppendPath(assetName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string sentShareName, string assetName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/assets/", false); + uri.AppendPath(assetName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetAssetsNextPageRequest(string nextLink, string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ClassificationRulesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ClassificationRulesClient.cs new file mode 100644 index 000000000000..5f4090b76f63 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ClassificationRulesClient.cs @@ -0,0 +1,529 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The ClassificationRules service client. + /// The ClassificationRules service client. + public partial class ClassificationRulesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of ClassificationRulesClient for mocking. + protected ClassificationRulesClient() + { + } + + /// Initializes a new instance of ClassificationRulesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public ClassificationRulesClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of ClassificationRulesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public ClassificationRulesClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get a classification rule. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetClassificationRuleAsync(string classificationRuleName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.GetClassificationRule"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationRuleRequest(classificationRuleName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a classification rule. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetClassificationRule(string classificationRuleName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.GetClassificationRule"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationRuleRequest(classificationRuleName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates or Updates a classification rule. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string classificationRuleName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(classificationRuleName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates or Updates a classification rule. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string classificationRuleName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(classificationRuleName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a classification rule. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteAsync(string classificationRuleName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(classificationRuleName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a classification rule. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Delete(string classificationRuleName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(classificationRuleName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Sets Classification Action on a specific classification rule version. + /// The String to use. + /// The Int32 to use. + /// The ClassificationAction to use. Allowed values: "Keep" | "Delete". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task TagClassificationVersionAsync(string classificationRuleName, int classificationRuleVersion, string action, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + Argument.AssertNotNull(action, nameof(action)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.TagClassificationVersion"); + scope.Start(); + try + { + using HttpMessage message = CreateTagClassificationVersionRequest(classificationRuleName, classificationRuleVersion, action, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Sets Classification Action on a specific classification rule version. + /// The String to use. + /// The Int32 to use. + /// The ClassificationAction to use. Allowed values: "Keep" | "Delete". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response TagClassificationVersion(string classificationRuleName, int classificationRuleVersion, string action, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + Argument.AssertNotNull(action, nameof(action)); + + using var scope = ClientDiagnostics.CreateScope("ClassificationRulesClient.TagClassificationVersion"); + scope.Start(); + try + { + using HttpMessage message = CreateTagClassificationVersionRequest(classificationRuleName, classificationRuleVersion, action, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List classification rules in Account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetClassificationRulesAsync(RequestContext context = null) + { + return GetClassificationRulesImplementationAsync("ClassificationRulesClient.GetClassificationRules", context); + } + + private AsyncPageable GetClassificationRulesImplementationAsync(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetClassificationRulesRequest(context) + : CreateGetClassificationRulesNextPageRequest(nextLink, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List classification rules in Account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetClassificationRules(RequestContext context = null) + { + return GetClassificationRulesImplementation("ClassificationRulesClient.GetClassificationRules", context); + } + + private Pageable GetClassificationRulesImplementation(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetClassificationRulesRequest(context) + : CreateGetClassificationRulesNextPageRequest(nextLink, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Lists the rule versions of a classification rule. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetVersionsByClassificationRuleNameAsync(string classificationRuleName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + return GetVersionsByClassificationRuleNameImplementationAsync("ClassificationRulesClient.GetVersionsByClassificationRuleName", classificationRuleName, context); + } + + private AsyncPageable GetVersionsByClassificationRuleNameImplementationAsync(string diagnosticsScopeName, string classificationRuleName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetVersionsByClassificationRuleNameRequest(classificationRuleName, context) + : CreateGetVersionsByClassificationRuleNameNextPageRequest(nextLink, classificationRuleName, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Lists the rule versions of a classification rule. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetVersionsByClassificationRuleName(string classificationRuleName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(classificationRuleName, nameof(classificationRuleName)); + + return GetVersionsByClassificationRuleNameImplementation("ClassificationRulesClient.GetVersionsByClassificationRuleName", classificationRuleName, context); + } + + private Pageable GetVersionsByClassificationRuleNameImplementation(string diagnosticsScopeName, string classificationRuleName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetVersionsByClassificationRuleNameRequest(classificationRuleName, context) + : CreateGetVersionsByClassificationRuleNameNextPageRequest(nextLink, classificationRuleName, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetClassificationRuleRequest(string classificationRuleName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/classificationrules/", false); + uri.AppendPath(classificationRuleName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string classificationRuleName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/classificationrules/", false); + uri.AppendPath(classificationRuleName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string classificationRuleName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/classificationrules/", false); + uri.AppendPath(classificationRuleName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetClassificationRulesRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/classificationrules", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetVersionsByClassificationRuleNameRequest(string classificationRuleName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/classificationrules/", false); + uri.AppendPath(classificationRuleName, true); + uri.AppendPath("/versions", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateTagClassificationVersionRequest(string classificationRuleName, int classificationRuleVersion, string action, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/classificationrules/", false); + uri.AppendPath(classificationRuleName, true); + uri.AppendPath("/versions/", false); + uri.AppendPath(classificationRuleVersion, true); + uri.AppendPath("/:tag", false); + uri.AppendQuery("action", action, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetClassificationRulesNextPageRequest(string nextLink, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetVersionsByClassificationRuleNameNextPageRequest(string nextLink, string classificationRuleName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier200204; + private static ResponseClassifier ResponseClassifier200204 => _responseClassifier200204 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 204 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/CollectionClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/CollectionClient.cs new file mode 100644 index 000000000000..cbfd05457aca --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/CollectionClient.cs @@ -0,0 +1,305 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Collection service client. + /// The Collection service client. + public partial class CollectionClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of CollectionClient for mocking. + protected CollectionClient() + { + } + + /// Initializes a new instance of CollectionClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public CollectionClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of CollectionClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public CollectionClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// + /// Creates or updates an entity to a collection. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// the collection unique name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string collection, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(collection, nameof(collection)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("CollectionClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(collection, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Creates or updates an entity to a collection. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// the collection unique name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string collection, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(collection, nameof(collection)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("CollectionClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(collection, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Creates or updates entities in bulk to a collection. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// the collection unique name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateBulkAsync(string collection, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(collection, nameof(collection)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("CollectionClient.CreateOrUpdateBulk"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateBulkRequest(collection, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Creates or updates entities in bulk to a collection. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// the collection unique name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdateBulk(string collection, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(collection, nameof(collection)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("CollectionClient.CreateOrUpdateBulk"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateBulkRequest(collection, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Move existing entities to the target collection. + /// the collection unique name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task MoveEntitiesToCollectionAsync(string collection, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(collection, nameof(collection)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("CollectionClient.MoveEntitiesToCollection"); + scope.Start(); + try + { + using HttpMessage message = CreateMoveEntitiesToCollectionRequest(collection, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Move existing entities to the target collection. + /// the collection unique name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response MoveEntitiesToCollection(string collection, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(collection, nameof(collection)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("CollectionClient.MoveEntitiesToCollection"); + scope.Start(); + try + { + using HttpMessage message = CreateMoveEntitiesToCollectionRequest(collection, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateCreateOrUpdateRequest(string collection, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/collections/", false); + uri.AppendPath(collection, true); + uri.AppendPath("/entity", false); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateCreateOrUpdateBulkRequest(string collection, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/collections/", false); + uri.AppendPath(collection, true); + uri.AppendPath("/entity/bulk", false); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateMoveEntitiesToCollectionRequest(string collection, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/collections/", false); + uri.AppendPath(collection, true); + uri.AppendPath("/entity/moveHere", false); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DataSourcesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DataSourcesClient.cs new file mode 100644 index 000000000000..598d56dc029b --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DataSourcesClient.cs @@ -0,0 +1,357 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The DataSources service client. + /// The DataSources service client. + public partial class DataSourcesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of DataSourcesClient for mocking. + protected DataSourcesClient() + { + } + + /// Initializes a new instance of DataSourcesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public DataSourcesClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of DataSourcesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public DataSourcesClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Creates or Updates a data source. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string dataSourceName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSourcesClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates or Updates a data source. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string dataSourceName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSourcesClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a data source. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetDataSourceAsync(string dataSourceName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSourcesClient.GetDataSource"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDataSourceRequest(dataSourceName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a data source. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetDataSource(string dataSourceName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSourcesClient.GetDataSource"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDataSourceRequest(dataSourceName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a data source. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteAsync(string dataSourceName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSourcesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(dataSourceName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a data source. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Delete(string dataSourceName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSourcesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(dataSourceName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List data sources in Data catalog. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetDataSourcesAsync(RequestContext context = null) + { + return GetDataSourcesImplementationAsync("DataSourcesClient.GetDataSources", context); + } + + private AsyncPageable GetDataSourcesImplementationAsync(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetDataSourcesRequest(context) + : CreateGetDataSourcesNextPageRequest(nextLink, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List data sources in Data catalog. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetDataSources(RequestContext context = null) + { + return GetDataSourcesImplementation("DataSourcesClient.GetDataSources", context); + } + + private Pageable GetDataSourcesImplementation(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetDataSourcesRequest(context) + : CreateGetDataSourcesNextPageRequest(nextLink, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateCreateOrUpdateRequest(string dataSourceName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetDataSourceRequest(string dataSourceName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateDeleteRequest(string dataSourceName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetDataSourcesRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetDataSourcesNextPageRequest(string nextLink, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200204; + private static ResponseClassifier ResponseClassifier200204 => _responseClassifier200204 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DatasourcePreferencesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DatasourcePreferencesClient.cs new file mode 100644 index 000000000000..55dbb3168ae4 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DatasourcePreferencesClient.cs @@ -0,0 +1,136 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The DatasourcePreferences service client. + /// The DatasourcePreferences service client. + public partial class DatasourcePreferencesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of DatasourcePreferencesClient for mocking. + protected DatasourcePreferencesClient() + { + } + + /// Initializes a new instance of DatasourcePreferencesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public DatasourcePreferencesClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of DatasourcePreferencesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public DatasourcePreferencesClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get Datasource Preferences for a given scope. + /// Scope. + /// Is call from a Gondor client. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetDatasourcePreferenceAsync(string scope, bool? isProjectGondor = null, RequestContext context = null) + { + Argument.AssertNotNull(scope, nameof(scope)); + + using var scope0 = ClientDiagnostics.CreateScope("DatasourcePreferencesClient.GetDatasourcePreference"); + scope0.Start(); + try + { + using HttpMessage message = CreateGetDatasourcePreferenceRequest(scope, isProjectGondor, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope0.Failed(e); + throw; + } + } + + /// Get Datasource Preferences for a given scope. + /// Scope. + /// Is call from a Gondor client. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetDatasourcePreference(string scope, bool? isProjectGondor = null, RequestContext context = null) + { + Argument.AssertNotNull(scope, nameof(scope)); + + using var scope0 = ClientDiagnostics.CreateScope("DatasourcePreferencesClient.GetDatasourcePreference"); + scope0.Start(); + try + { + using HttpMessage message = CreateGetDatasourcePreferenceRequest(scope, isProjectGondor, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope0.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetDatasourcePreferenceRequest(string scope, bool? isProjectGondor, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRaw("/pds", false); + uri.AppendPath("/datasource-preferences", false); + uri.AppendQuery("scope", scope, true); + if (isProjectGondor != null) + { + uri.AppendQuery("isProjectGondor", isProjectGondor.Value, true); + } + uri.AppendQuery("api-version", "2022-11-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DiscoveryClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DiscoveryClient.cs new file mode 100644 index 000000000000..e455ba30b5f7 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/DiscoveryClient.cs @@ -0,0 +1,332 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Discovery service client. + /// The Discovery service client. + public partial class DiscoveryClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of DiscoveryClient for mocking. + protected DiscoveryClient() + { + } + + /// Initializes a new instance of DiscoveryClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public DiscoveryClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of DiscoveryClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public DiscoveryClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Gets data using search. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task QueryAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.Query"); + scope.Start(); + try + { + using HttpMessage message = CreateQueryRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets data using search. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Query(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.Query"); + scope.Start(); + try + { + using HttpMessage message = CreateQueryRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get search suggestions by query criteria. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task SuggestAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.Suggest"); + scope.Start(); + try + { + using HttpMessage message = CreateSuggestRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get search suggestions by query criteria. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Suggest(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.Suggest"); + scope.Start(); + try + { + using HttpMessage message = CreateSuggestRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Browse entities by path or entity type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task BrowseAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.Browse"); + scope.Start(); + try + { + using HttpMessage message = CreateBrowseRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Browse entities by path or entity type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Browse(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.Browse"); + scope.Start(); + try + { + using HttpMessage message = CreateBrowseRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get auto complete options. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task AutoCompleteAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.AutoComplete"); + scope.Start(); + try + { + using HttpMessage message = CreateAutoCompleteRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get auto complete options. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response AutoComplete(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DiscoveryClient.AutoComplete"); + scope.Start(); + try + { + using HttpMessage message = CreateAutoCompleteRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateQueryRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/search/query", false); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateSuggestRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/search/suggest", false); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateBrowseRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/browse", false); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateAutoCompleteRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/search/autocomplete", false); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AcceptedSentSharesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AcceptedSentSharesClient.xml new file mode 100644 index 000000000000..137bae666b63 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AcceptedSentSharesClient.xml @@ -0,0 +1,727 @@ + + + + + +This sample shows how to call GetAcceptedSentShareAsync with required parameters and parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +Response response = await client.GetAcceptedSentShareAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get an accepted sent share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call GetAcceptedSentShare with required parameters and parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +Response response = client.GetAcceptedSentShare("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get an accepted sent share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call GetAcceptedSentSharesAsync with required parameters and parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +await foreach (var data in client.GetAcceptedSentSharesAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetAcceptedSentSharesAsync with all parameters, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +await foreach (var data in client.GetAcceptedSentSharesAsync("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +Get list of accepted sent shares + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AcceptedSentShareListValue: +{ + shareKind: "InPlace", # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetAcceptedSentShares with required parameters and parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +foreach (var data in client.GetAcceptedSentShares("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetAcceptedSentShares with all parameters, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +foreach (var data in client.GetAcceptedSentShares("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +Get list of accepted sent shares + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AcceptedSentShareListValue: +{ + shareKind: "InPlace", # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call ReinstateAsync with required parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new {}, + shareKind = "InPlace", +}; + +var operation = await client.ReinstateAsync(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ReinstateAsync with all parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new { + expirationDate = "2022-05-10T18:57:31.2311892Z", + }, + shareKind = "InPlace", +}; + +var operation = await client.ReinstateAsync(WaitUntil.Completed, "", "", RequestContent.Create(data), ""); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Reinstate a revoked accepted sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call Reinstate with required parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new {}, + shareKind = "InPlace", +}; + +var operation = client.Reinstate(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Reinstate with all parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new { + expirationDate = "2022-05-10T18:57:31.2311892Z", + }, + shareKind = "InPlace", +}; + +var operation = client.Reinstate(WaitUntil.Completed, "", "", RequestContent.Create(data), ""); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Reinstate a revoked accepted sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call RevokeAsync with required parameters and parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var operation = await client.RevokeAsync(WaitUntil.Completed, "", ""); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call RevokeAsync with all parameters, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var operation = await client.RevokeAsync(WaitUntil.Completed, "", "", ""); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Revoke an accepted sent share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call Revoke with required parameters and parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var operation = client.Revoke(WaitUntil.Completed, "", ""); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Revoke with all parameters, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var operation = client.Revoke(WaitUntil.Completed, "", "", ""); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Revoke an accepted sent share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call UpdateExpirationAsync with required parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new {}, + shareKind = "InPlace", +}; + +var operation = await client.UpdateExpirationAsync(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateExpirationAsync with all parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new { + expirationDate = "2022-05-10T18:57:31.2311892Z", + }, + shareKind = "InPlace", +}; + +var operation = await client.UpdateExpirationAsync(WaitUntil.Completed, "", "", RequestContent.Create(data), ""); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Update the expiration date of an accepted sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call UpdateExpiration with required parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new {}, + shareKind = "InPlace", +}; + +var operation = client.UpdateExpiration(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateExpiration with all parameters and request content, and how to parse the result. +"); +var client = new AcceptedSentSharesClient(endpoint, credential); + +var data = new { + properties = new { + expirationDate = "2022-05-10T18:57:31.2311892Z", + }, + shareKind = "InPlace", +}; + +var operation = client.UpdateExpiration(WaitUntil.Completed, "", "", RequestContent.Create(data), ""); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Update the expiration date of an accepted sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceAcceptedSentShareSchema for InPlaceAcceptedSentShare: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. created at + expirationDate: string (ISO 8601 Format), # Optional. Expiration date of the received share in UTC format + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation and created the received share + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation and created the received share + receiverTargetObjectId: string, # Optional. Receiver's target object id + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation and created the received share + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sharedAt: string (ISO 8601 Format), # Optional. Shared at + }, # Required. Properties of in place accepted sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AssetMappingsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AssetMappingsClient.xml new file mode 100644 index 000000000000..fccaebaca198 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AssetMappingsClient.xml @@ -0,0 +1,563 @@ + + + + + +This sample shows how to call GetAssetMappingAsync with required parameters and parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +Response response = await client.GetAssetMappingAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get an asset mapping for a received share + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetMappingSchema for AdlsGen2AccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the adls gen2 storage account asset mapping. + kind: AdlsGen2Account, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetMappingSchema for BlobAccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the blob storage account asset mapping. + kind: BlobAccount, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call GetAssetMapping with required parameters and parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +Response response = client.GetAssetMapping("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get an asset mapping for a received share + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetMappingSchema for AdlsGen2AccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the adls gen2 storage account asset mapping. + kind: AdlsGen2Account, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetMappingSchema for BlobAccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the blob storage account asset mapping. + kind: BlobAccount, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call GetAssetMappingsAsync with required parameters and parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +await foreach (var data in client.GetAssetMappingsAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetAssetMappingsAsync with all parameters, and how to parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +await foreach (var data in client.GetAssetMappingsAsync("", "", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List asset mappings for a received share + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AssetMappingListValue: +{ + kind: "AdlsGen2Account" | "BlobAccount", # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetAssetMappings with required parameters and parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +foreach (var data in client.GetAssetMappings("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetAssetMappings with all parameters, and how to parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +foreach (var data in client.GetAssetMappings("", "", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List asset mappings for a received share + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AssetMappingListValue: +{ + kind: "AdlsGen2Account" | "BlobAccount", # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call CreateAsync with required parameters and request content, and how to parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +var data = new { + properties = new { + assetId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a", + containerName = "", + folder = "", + storageAccountResourceId = "", + }, + kind = "AdlsGen2Account", +}; + +var operation = await client.CreateAsync(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateAsync with all parameters and request content, and how to parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +var data = new { + properties = new { + assetId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a", + containerName = "", + folder = "", + mountPath = "", + storageAccountResourceId = "", + }, + kind = "AdlsGen2Account", +}; + +var operation = await client.CreateAsync(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create an asset mapping on a received share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetMappingSchema for AdlsGen2AccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the adls gen2 storage account asset mapping. + kind: AdlsGen2Account, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetMappingSchema for BlobAccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the blob storage account asset mapping. + kind: BlobAccount, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetMappingSchema for AdlsGen2AccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the adls gen2 storage account asset mapping. + kind: AdlsGen2Account, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetMappingSchema for BlobAccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the blob storage account asset mapping. + kind: BlobAccount, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call Create with required parameters and request content, and how to parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +var data = new { + properties = new { + assetId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a", + containerName = "", + folder = "", + storageAccountResourceId = "", + }, + kind = "AdlsGen2Account", +}; + +var operation = client.Create(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Create with all parameters and request content, and how to parse the result. +"); +var client = new AssetMappingsClient(endpoint, credential); + +var data = new { + properties = new { + assetId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a", + containerName = "", + folder = "", + mountPath = "", + storageAccountResourceId = "", + }, + kind = "AdlsGen2Account", +}; + +var operation = client.Create(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create an asset mapping on a received share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetMappingSchema for AdlsGen2AccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the adls gen2 storage account asset mapping. + kind: AdlsGen2Account, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetMappingSchema for BlobAccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the blob storage account asset mapping. + kind: BlobAccount, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetMappingSchema for AdlsGen2AccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the adls gen2 storage account asset mapping. + kind: AdlsGen2Account, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetMappingSchema for BlobAccountAssetMapping: +{ + properties: { + assetId: Guid, # Required. The id of the sender asset. + assetMappingStatus: "Ok" | "Broken", # Optional. State of asset mapping + containerName: string, # Required. Name of the container to received the shared paths. + folder: string, # Required. Folder under which the shared paths will be reflected. + location: string, # Optional. Location of the receiver storage account. + mountPath: string, # Optional. Optional mount path for the shared paths. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + storageAccountResourceId: string, # Required. Resource id of the receiver storage account. + }, # Required. Properties of the blob storage account asset mapping. + kind: BlobAccount, # Required. Types of asset mapping. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call DeleteAsync with required parameters. +"); +var client = new AssetMappingsClient(endpoint, credential); + +var operation = await client.DeleteAsync(WaitUntil.Completed, "", ""); + +var response = await operation.WaitForCompletionResponseAsync(); +Console.WriteLine(response.Status) +]]> + + +Delete an asset mapping for a received share + + + + +This sample shows how to call Delete with required parameters. +"); +var client = new AssetMappingsClient(endpoint, credential); + +var operation = client.Delete(WaitUntil.Completed, "", ""); + +var response = operation.WaitForCompletionResponse(); +Console.WriteLine(response.Status) +]]> + + +Delete an asset mapping for a received share + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AssetsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AssetsClient.xml new file mode 100644 index 000000000000..d0f1db07f954 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/AssetsClient.xml @@ -0,0 +1,561 @@ + + + + + +This sample shows how to call GetAssetAsync with required parameters and parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +Response response = await client.GetAssetAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get an asset on a sent share + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetSchema for AdlsGen2AccountAsset: +{ + properties: { + location: string, # Optional. Location of the adls gen2 storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of adls gen2 storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the adls gen2 storage account. + }, # Required. Adls gen 2 account asset properties + kind: AdlsGen2Account, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetSchema for BlobAccountAsset: +{ + properties: { + location: string, # Optional. Location of the blob storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of blob storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the blob storage account. + }, # Required. Blob storage account asset properties + kind: BlobAccount, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call GetAsset with required parameters and parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +Response response = client.GetAsset("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get an asset on a sent share + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetSchema for AdlsGen2AccountAsset: +{ + properties: { + location: string, # Optional. Location of the adls gen2 storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of adls gen2 storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the adls gen2 storage account. + }, # Required. Adls gen 2 account asset properties + kind: AdlsGen2Account, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetSchema for BlobAccountAsset: +{ + properties: { + location: string, # Optional. Location of the blob storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of blob storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the blob storage account. + }, # Required. Blob storage account asset properties + kind: BlobAccount, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call GetAssetsAsync with required parameters and parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +await foreach (var data in client.GetAssetsAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetAssetsAsync with all parameters, and how to parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +await foreach (var data in client.GetAssetsAsync("", "", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List assets on a sent share + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AssetListValue: +{ + kind: "AdlsGen2Account" | "BlobAccount", # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetAssets with required parameters and parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +foreach (var data in client.GetAssets("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetAssets with all parameters, and how to parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +foreach (var data in client.GetAssets("", "", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List assets on a sent share + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AssetListValue: +{ + kind: "AdlsGen2Account" | "BlobAccount", # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call CreateAsync with required parameters and request content and parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +var data = new { + properties = new { + paths = new[] { + new { + containerName = "", + receiverPath = "", + senderPath = "", + } + }, + receiverAssetName = "", + storageAccountResourceId = "", + }, + kind = "AdlsGen2Account", +}; + +var operation = await client.CreateAsync(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create an asset on a sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetSchema for AdlsGen2AccountAsset: +{ + properties: { + location: string, # Optional. Location of the adls gen2 storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of adls gen2 storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the adls gen2 storage account. + }, # Required. Adls gen 2 account asset properties + kind: AdlsGen2Account, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetSchema for BlobAccountAsset: +{ + properties: { + location: string, # Optional. Location of the blob storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of blob storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the blob storage account. + }, # Required. Blob storage account asset properties + kind: BlobAccount, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetSchema for AdlsGen2AccountAsset: +{ + properties: { + location: string, # Optional. Location of the adls gen2 storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of adls gen2 storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the adls gen2 storage account. + }, # Required. Adls gen 2 account asset properties + kind: AdlsGen2Account, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetSchema for BlobAccountAsset: +{ + properties: { + location: string, # Optional. Location of the blob storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of blob storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the blob storage account. + }, # Required. Blob storage account asset properties + kind: BlobAccount, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call Create with required parameters and request content and parse the result. +"); +var client = new AssetsClient(endpoint, credential); + +var data = new { + properties = new { + paths = new[] { + new { + containerName = "", + receiverPath = "", + senderPath = "", + } + }, + receiverAssetName = "", + storageAccountResourceId = "", + }, + kind = "AdlsGen2Account", +}; + +var operation = client.Create(WaitUntil.Completed, "", "", RequestContent.Create(data)); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create an asset on a sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetSchema for AdlsGen2AccountAsset: +{ + properties: { + location: string, # Optional. Location of the adls gen2 storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of adls gen2 storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the adls gen2 storage account. + }, # Required. Adls gen 2 account asset properties + kind: AdlsGen2Account, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetSchema for BlobAccountAsset: +{ + properties: { + location: string, # Optional. Location of the blob storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of blob storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the blob storage account. + }, # Required. Blob storage account asset properties + kind: BlobAccount, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AdlsGen2AccountAssetSchema for AdlsGen2AccountAsset: +{ + properties: { + location: string, # Optional. Location of the adls gen2 storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of adls gen2 storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the adls gen2 storage account. + }, # Required. Adls gen 2 account asset properties + kind: AdlsGen2Account, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
BlobAccountAssetSchema for BlobAccountAsset: +{ + properties: { + location: string, # Optional. Location of the blob storage account. + paths: [ + { + containerName: string, # Required. Gets or sets the container name. + receiverPath: string, # Optional. Gets or sets the path on the receiver side where the asset is to be mapped. + senderPath: string, # Optional. Gets or sets the path to file/folder within the container to be shared. + } + ], # Required. A list of blob storage account paths to be shared. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receiverAssetName: string, # Required. Name of the asset for the receiver. + storageAccountResourceId: string, # Required. Resource id of the blob storage account. + }, # Required. Blob storage account asset properties + kind: BlobAccount, # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call DeleteAsync with required parameters. +"); +var client = new AssetsClient(endpoint, credential); + +var operation = await client.DeleteAsync(WaitUntil.Completed, "", ""); + +var response = await operation.WaitForCompletionResponseAsync(); +Console.WriteLine(response.Status) +]]> + + +Delete an asset on a sent share + + + + +This sample shows how to call Delete with required parameters. +"); +var client = new AssetsClient(endpoint, credential); + +var operation = client.Delete(WaitUntil.Completed, "", ""); + +var response = operation.WaitForCompletionResponse(); +Console.WriteLine(response.Status) +]]> + + +Delete an asset on a sent share + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ClassificationRulesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ClassificationRulesClient.xml new file mode 100644 index 000000000000..f52c7bf23c51 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ClassificationRulesClient.xml @@ -0,0 +1,759 @@ + + + + + +This sample shows how to call GetClassificationRuleAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetClassificationRuleAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetClassificationRule with required parameters and parse the result. +", credential); + +Response response = client.GetClassificationRule(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "System", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + description = "", + classificationName = "", + ruleStatus = "Enabled", + }, + kind = "System", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdate with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "System", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + description = "", + classificationName = "", + ruleStatus = "Enabled", + }, + kind = "System", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call DeleteAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call Delete with required parameters and parse the result. +", credential); + +Response response = client.Delete(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
SystemClassificationRuleSchema for SystemClassificationRule: +{ + properties: { + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: System, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 1 more JSON objects
CustomClassificationRuleSchema for CustomClassificationRule: +{ + properties: { + minimumPercentageMatch: number, # Optional. + classificationAction: "Keep" | "Delete", # Optional. + dataPatterns: [ + { + kind: "Regex", # Required. + } + ], # Optional. + columnPatterns: [ClassificationRulePattern], # Optional. + description: string, # Optional. + version: number, # Optional. + classificationName: string, # Optional. + ruleStatus: "Enabled" | "Disabled", # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Custom, # Required. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call TagClassificationVersionAsync with required parameters and parse the result. +", credential); + +Response response = await client.TagClassificationVersionAsync("", 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("scanResultId").ToString()); +Console.WriteLine(result.GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("status").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("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for OperationResponse: +{ + scanResultId: Guid, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + status: "Accepted" | "InProgress" | "TransientFailure" | "Succeeded" | "Failed" | "Canceled", # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorInfo], # Optional. + } + ], # Optional. + }, # Optional. +} + + + + + + +This sample shows how to call TagClassificationVersion with required parameters and parse the result. +", credential); + +Response response = client.TagClassificationVersion("", 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("scanResultId").ToString()); +Console.WriteLine(result.GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("status").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("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for OperationResponse: +{ + scanResultId: Guid, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + status: "Accepted" | "InProgress" | "TransientFailure" | "Succeeded" | "Failed" | "Canceled", # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorInfo], # Optional. + } + ], # Optional. + }, # Optional. +} + + + + + + +This sample shows how to call GetClassificationRulesAsync and parse the result. +", credential); + +await foreach (var data in client.GetClassificationRulesAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ClassificationRuleListValue: +{ + kind: "System" | "Custom", # Required. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetClassificationRules and parse the result. +", credential); + +foreach (var data in client.GetClassificationRules()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ClassificationRuleListValue: +{ + kind: "System" | "Custom", # Required. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetVersionsByClassificationRuleNameAsync with required parameters and parse the result. +", credential); + +await foreach (var data in client.GetVersionsByClassificationRuleNameAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ClassificationRuleListValue: +{ + kind: "System" | "Custom", # Required. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetVersionsByClassificationRuleName with required parameters and parse the result. +", credential); + +foreach (var data in client.GetVersionsByClassificationRuleName("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ClassificationRuleListValue: +{ + kind: "System" | "Custom", # Required. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/CollectionClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/CollectionClient.xml new file mode 100644 index 000000000000..2dfb8a3b76f2 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/CollectionClient.xml @@ -0,0 +1,1837 @@ + + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entity = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call CreateOrUpdate with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entity = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call CreateOrUpdateBulkAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateOrUpdateBulkAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateBulkAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entities = new[] { + new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = await client.CreateOrUpdateBulkAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call CreateOrUpdateBulk with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateOrUpdateBulk("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateBulk with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entities = new[] { + new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = client.CreateOrUpdateBulk("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call MoveEntitiesToCollectionAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.MoveEntitiesToCollectionAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call MoveEntitiesToCollectionAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entityGuids = new[] { + "" + }, +}; + +Response response = await client.MoveEntitiesToCollectionAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for MoveEntitiesRequest: +{ + entityGuids: [string], # Optional. An array of entity guids to be moved to target collection. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call MoveEntitiesToCollection with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.MoveEntitiesToCollection("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call MoveEntitiesToCollection with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entityGuids = new[] { + "" + }, +}; + +Response response = client.MoveEntitiesToCollection("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for MoveEntitiesRequest: +{ + entityGuids: [string], # Optional. An array of entity guids to be moved to target collection. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DataSourcesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DataSourcesClient.xml new file mode 100644 index 000000000000..f4b5eb7ebd5f --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DataSourcesClient.xml @@ -0,0 +1,14545 @@ + + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "AzureSubscription", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + subscriptionId = "", + collection = new { + referenceName = "", + type = "", + }, + }, + kind = "AzureSubscription", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdate with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "AzureSubscription", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + subscriptionId = "", + collection = new { + referenceName = "", + type = "", + }, + }, + kind = "AzureSubscription", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetDataSourceAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetDataSourceAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetDataSource with required parameters and parse the result. +", credential); + +Response response = client.GetDataSource(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call DeleteAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call Delete with required parameters and parse the result. +", credential); + +Response response = client.Delete(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionDataSourceSchema for AzureSubscriptionDataSource: +{ + properties: { + subscriptionId: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupDataSourceSchema for AzureResourceGroupDataSource: +{ + properties: { + subscriptionId: string, # Optional. + resourceGroup: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceDataSourceSchema for AzureSynapseWorkspaceDataSource: +{ + properties: { + dedicatedSqlEndpoint: string, # Optional. + serverlessSqlEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseDataSourceSchema for AzureSynapseDataSource: +{ + properties: { + sqlEndpoint: string, # Optional. + sqlOnDemandEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1DataSourceSchema for AdlsGen1DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2DataSourceSchema for AdlsGen2DataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountDataSourceSchema for AmazonAccountDataSource: +{ + properties: { + awsAccountId: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3DataSourceSchema for AmazonS3DataSource: +{ + properties: { + serviceUrl: string, # Optional. + roleARN: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlDataSourceSchema for AmazonSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbDataSourceSchema for AzureCosmosDbDataSource: +{ + properties: { + accountUri: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerDataSourceSchema for AzureDataExplorerDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceDataSourceSchema for AzureFileServiceDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseDataSourceSchema for AzureSqlDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlDataSourceSchema for AmazonPostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlDataSourceSchema for AzurePostgreSqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseDataSourceSchema for SqlServerDatabaseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceDataSourceSchema for AzureSqlDatabaseManagedInstanceDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseDataSourceSchema for AzureSqlDataWarehouseDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlDataSourceSchema for AzureMySqlDataSource: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageDataSourceSchema for AzureStorageDataSource: +{ + properties: { + endpoint: string, # Optional. + resourceGroup: string, # Optional. + subscriptionId: string, # Optional. + location: string, # Optional. + resourceName: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataDataSourceSchema for TeradataDataSource: +{ + properties: { + host: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Teradata, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleDataSourceSchema for OracleDataSource: +{ + properties: { + host: string, # Optional. + port: string, # Optional. + service: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: Oracle, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaDataSourceSchema for SapS4HanaDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccDataSourceSchema for SapEccDataSource: +{ + properties: { + applicationServer: string, # Optional. + systemNumber: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEcc, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDataSourceSchema for PowerBIDataSource: +{ + properties: { + tenant: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBI, # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetDataSourcesAsync and parse the result. +", credential); + +await foreach (var data in client.GetDataSourcesAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for DataSourceListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetDataSources and parse the result. +", credential); + +foreach (var data in client.GetDataSources()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("parentId").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("startTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("endTime").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("runType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scans")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for DataSourceListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scans: [ + { + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DatasourcePreferencesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DatasourcePreferencesClient.xml new file mode 100644 index 000000000000..20cd98171e4f --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DatasourcePreferencesClient.xml @@ -0,0 +1,133 @@ + + + + + +This sample shows how to call GetDatasourcePreferenceAsync with required parameters and parse the result. +"); +var client = new DatasourcePreferencesClient(endpoint, credential); + +Response response = await client.GetDatasourcePreferenceAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetDatasourcePreferenceAsync with all parameters, and how to parse the result. +"); +var client = new DatasourcePreferencesClient(endpoint, credential); + +Response response = await client.GetDatasourcePreferenceAsync("", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("consent").GetProperty("properties").GetProperty("scanner").GetProperty("metadata").ToString()); +Console.WriteLine(result.GetProperty("consent").GetProperty("properties").GetProperty("scanner").GetProperty("classification").ToString()); +Console.WriteLine(result.GetProperty("consent").GetProperty("properties").GetProperty("dataUseGovernance").ToString()); +Console.WriteLine(result.GetProperty("consent").GetProperty("excludedScopes")[0].ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("location").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("tenantId").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("gatewayEndpoint").ToString()); +Console.WriteLine(result.GetProperty("frequency").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for DatasourcePreferencesResponse: +{ + consent: { + properties: { + scanner: { + metadata: boolean, # Optional. Consent for metadata discovery. + classification: boolean, # Optional. Consent for classification discovery. + }, # Optional. Represents the collection of consent information for scanning service. + dataUseGovernance: boolean, # Optional. Consent for data use governance. + }, # Optional. Consent properties. + excludedScopes: [string], # Optional. Child scopes that need to be excluded (optional). + }, # Optional. Consent information related to a resource. + accountInfo: { + id: string, # Optional. Id of the purview account. + name: string, # Optional. Name of the purview account. + location: string, # Optional. Region where purview account is created. + tenantId: string, # Optional. Tenant id of the purview account. + gatewayEndpoint: string, # Optional. Purview account gateway endpoint. + }, # Optional. Represents a purview account. + frequency: number, # Optional. This represents the frequency at which the RPs will check for consent information. +} + + + + + + +This sample shows how to call GetDatasourcePreference with required parameters and parse the result. +"); +var client = new DatasourcePreferencesClient(endpoint, credential); + +Response response = client.GetDatasourcePreference(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetDatasourcePreference with all parameters, and how to parse the result. +"); +var client = new DatasourcePreferencesClient(endpoint, credential); + +Response response = client.GetDatasourcePreference("", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("consent").GetProperty("properties").GetProperty("scanner").GetProperty("metadata").ToString()); +Console.WriteLine(result.GetProperty("consent").GetProperty("properties").GetProperty("scanner").GetProperty("classification").ToString()); +Console.WriteLine(result.GetProperty("consent").GetProperty("properties").GetProperty("dataUseGovernance").ToString()); +Console.WriteLine(result.GetProperty("consent").GetProperty("excludedScopes")[0].ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("location").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("tenantId").ToString()); +Console.WriteLine(result.GetProperty("accountInfo").GetProperty("gatewayEndpoint").ToString()); +Console.WriteLine(result.GetProperty("frequency").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for DatasourcePreferencesResponse: +{ + consent: { + properties: { + scanner: { + metadata: boolean, # Optional. Consent for metadata discovery. + classification: boolean, # Optional. Consent for classification discovery. + }, # Optional. Represents the collection of consent information for scanning service. + dataUseGovernance: boolean, # Optional. Consent for data use governance. + }, # Optional. Consent properties. + excludedScopes: [string], # Optional. Child scopes that need to be excluded (optional). + }, # Optional. Consent information related to a resource. + accountInfo: { + id: string, # Optional. Id of the purview account. + name: string, # Optional. Name of the purview account. + location: string, # Optional. Region where purview account is created. + tenantId: string, # Optional. Tenant id of the purview account. + gatewayEndpoint: string, # Optional. Purview account gateway endpoint. + }, # Optional. Represents a purview account. + frequency: number, # Optional. This represents the frequency at which the RPs will check for consent information. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DiscoveryClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DiscoveryClient.xml new file mode 100644 index 000000000000..ab309a3d41a8 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/DiscoveryClient.xml @@ -0,0 +1,659 @@ + + + + + +This sample shows how to call QueryAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.QueryAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call QueryAsync with all request content, and how to parse the result. +", credential); + +var data = new { + keywords = "", + offset = 1234, + limit = 1234, + filter = new {}, + facets = new[] { + new { + count = 1234, + facet = "", + sort = new {}, + } + }, + taxonomySetting = new { + assetTypes = new[] { + "" + }, + facet = new { + count = 1234, + facet = "", + sort = new {}, + }, + }, +}; + +Response response = await client.QueryAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("@search.count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("assetType")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("assetType")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classification")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classification")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classificationCategory")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classificationCategory")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("contactId")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("contactId")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("fileExtension")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("fileExtension")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("label")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("label")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("term")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("term")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("id")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("qualifiedName")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("name")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("description")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("entityType")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("entityType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("classification")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("label")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("glossaryName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("contactType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("assetType")[0].ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for SearchRequest: +{ + keywords: string, # Optional. The keywords applied to all searchable fields. + offset: number, # Optional. The offset. The default value is 0. The maximum value is 100000. + limit: number, # Optional. The limit of the number of the search result. default value is 50; maximum value is 1000. + filter: AnyObject, # Optional. The filter for the search. See examples for the usage of supported filters. + facets: [ + { + count: number, # Optional. The count of the facet item. + facet: string, # Optional. The name of the facet item. + sort: AnyObject, # Optional. Any object + } + ], # Optional. + taxonomySetting: { + assetTypes: [string], # Optional. + facet: SearchFacetItem, # Optional. The content of a search facet result item. + }, # Optional. +} + + +Response Body: + +Schema for SearchResult: +{ + @search.count: number, # Optional. The total number of search results (not the number of documents in a single page). + @search.facets: { + assetType: [ + { + count: number, # Optional. The count of the facet item. + value: string, # Optional. The name of the facet item. + } + ], # Optional. + classification: [SearchFacetItemValue], # Optional. + classificationCategory: [SearchFacetItemValue], # Optional. + contactId: [SearchFacetItemValue], # Optional. + fileExtension: [SearchFacetItemValue], # Optional. + label: [SearchFacetItemValue], # Optional. + term: [SearchFacetItemValue], # Optional. + }, # Optional. A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets. + value: [SearchResultValue], # Optional. +} + + + + + + +This sample shows how to call Query and parse the result. +", credential); + +var data = new {}; + +Response response = client.Query(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Query with all request content, and how to parse the result. +", credential); + +var data = new { + keywords = "", + offset = 1234, + limit = 1234, + filter = new {}, + facets = new[] { + new { + count = 1234, + facet = "", + sort = new {}, + } + }, + taxonomySetting = new { + assetTypes = new[] { + "" + }, + facet = new { + count = 1234, + facet = "", + sort = new {}, + }, + }, +}; + +Response response = client.Query(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("@search.count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("assetType")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("assetType")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classification")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classification")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classificationCategory")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("classificationCategory")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("contactId")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("contactId")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("fileExtension")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("fileExtension")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("label")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("label")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("term")[0].GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("@search.facets").GetProperty("term")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("id")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("qualifiedName")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("name")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("description")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.highlights").GetProperty("entityType")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("entityType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("classification")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("label")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("glossaryName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("contactType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("assetType")[0].ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for SearchRequest: +{ + keywords: string, # Optional. The keywords applied to all searchable fields. + offset: number, # Optional. The offset. The default value is 0. The maximum value is 100000. + limit: number, # Optional. The limit of the number of the search result. default value is 50; maximum value is 1000. + filter: AnyObject, # Optional. The filter for the search. See examples for the usage of supported filters. + facets: [ + { + count: number, # Optional. The count of the facet item. + facet: string, # Optional. The name of the facet item. + sort: AnyObject, # Optional. Any object + } + ], # Optional. + taxonomySetting: { + assetTypes: [string], # Optional. + facet: SearchFacetItem, # Optional. The content of a search facet result item. + }, # Optional. +} + + +Response Body: + +Schema for SearchResult: +{ + @search.count: number, # Optional. The total number of search results (not the number of documents in a single page). + @search.facets: { + assetType: [ + { + count: number, # Optional. The count of the facet item. + value: string, # Optional. The name of the facet item. + } + ], # Optional. + classification: [SearchFacetItemValue], # Optional. + classificationCategory: [SearchFacetItemValue], # Optional. + contactId: [SearchFacetItemValue], # Optional. + fileExtension: [SearchFacetItemValue], # Optional. + label: [SearchFacetItemValue], # Optional. + term: [SearchFacetItemValue], # Optional. + }, # Optional. A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets. + value: [SearchResultValue], # Optional. +} + + + + + + +This sample shows how to call SuggestAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.SuggestAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call SuggestAsync with all request content, and how to parse the result. +", credential); + +var data = new { + keywords = "", + limit = 1234, + filter = new {}, +}; + +Response response = await client.SuggestAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("entityType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("classification")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("label")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("glossaryName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("contactType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("assetType")[0].ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for SuggestRequest: +{ + keywords: string, # Optional. The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode. + limit: number, # Optional. The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100. + filter: AnyObject, # Optional. The filter for the search. +} + + +Response Body: + +Schema for SuggestResult: +{ + value: [SuggestResultValue], # Optional. +} + + + + + + +This sample shows how to call Suggest and parse the result. +", credential); + +var data = new {}; + +Response response = client.Suggest(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Suggest with all request content, and how to parse the result. +", credential); + +var data = new { + keywords = "", + limit = 1234, + filter = new {}, +}; + +Response response = client.Suggest(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("entityType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("classification")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("label")[0].ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("glossaryName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("term")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("contact")[0].GetProperty("contactType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("assetType")[0].ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for SuggestRequest: +{ + keywords: string, # Optional. The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode. + limit: number, # Optional. The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100. + filter: AnyObject, # Optional. The filter for the search. +} + + +Response Body: + +Schema for SuggestResult: +{ + value: [SuggestResultValue], # Optional. +} + + + + + + +This sample shows how to call BrowseAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.BrowseAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call BrowseAsync with all request content, and how to parse the result. +", credential); + +var data = new { + entityType = "", + path = "", + limit = 1234, + offset = 1234, +}; + +Response response = await client.BrowseAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("@search.count").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("entityType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("isLeaf").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("mail").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("contactType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("path").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("qualifiedName").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for BrowseRequest: +{ + entityType: string, # Optional. The entity type to browse as the root level entry point. + path: string, # Optional. The path to browse the next level child entities. + limit: number, # Optional. The number of browse items we hope to return. The maximum value is 10000. + offset: number, # Optional. The offset. The default value is 0. The maximum value is 100000. +} + + +Response Body: + +Schema for BrowseResult: +{ + @search.count: number, # Optional. The total number of browse results. + value: [BrowseResultValue], # Optional. +} + + + + + + +This sample shows how to call Browse and parse the result. +", credential); + +var data = new {}; + +Response response = client.Browse(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Browse with all request content, and how to parse the result. +", credential); + +var data = new { + entityType = "", + path = "", + limit = 1234, + offset = 1234, +}; + +Response response = client.Browse(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("@search.count").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("entityType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("isLeaf").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("mail").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("owner")[0].GetProperty("contactType").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("path").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("qualifiedName").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for BrowseRequest: +{ + entityType: string, # Optional. The entity type to browse as the root level entry point. + path: string, # Optional. The path to browse the next level child entities. + limit: number, # Optional. The number of browse items we hope to return. The maximum value is 10000. + offset: number, # Optional. The offset. The default value is 0. The maximum value is 100000. +} + + +Response Body: + +Schema for BrowseResult: +{ + @search.count: number, # Optional. The total number of browse results. + value: [BrowseResultValue], # Optional. +} + + + + + + +This sample shows how to call AutoCompleteAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.AutoCompleteAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call AutoCompleteAsync with all request content, and how to parse the result. +", credential); + +var data = new { + keywords = "", + limit = 1234, + filter = new {}, +}; + +Response response = await client.AutoCompleteAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AutoCompleteRequest: +{ + keywords: string, # Optional. The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. + limit: number, # Optional. The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100. + filter: AnyObject, # Optional. The filter for the autocomplete request. +} + + +Response Body: + +Schema for AutoCompleteResult: +{ + value: [AutoCompleteResultValue], # Optional. +} + + + + + + +This sample shows how to call AutoComplete and parse the result. +", credential); + +var data = new {}; + +Response response = client.AutoComplete(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call AutoComplete with all request content, and how to parse the result. +", credential); + +var data = new { + keywords = "", + limit = 1234, + filter = new {}, +}; + +Response response = client.AutoComplete(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AutoCompleteRequest: +{ + keywords: string, # Optional. The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. + limit: number, # Optional. The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100. + filter: AnyObject, # Optional. The filter for the autocomplete request. +} + + +Response Body: + +Schema for AutoCompleteResult: +{ + value: [AutoCompleteResultValue], # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/EmailRegistrationClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/EmailRegistrationClient.xml new file mode 100644 index 000000000000..31a461a04895 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/EmailRegistrationClient.xml @@ -0,0 +1,279 @@ + + + + + +This sample shows how to call ActivateAsync with required parameters and parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +var data = new {}; + +Response response = await client.ActivateAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ActivateAsync with all parameters and request content, and how to parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +var data = new { + properties = new { + activationCode = "", + }, +}; + +Response response = await client.ActivateAsync(RequestContent.Create(data), ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("activationCode").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("activationExpiration").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("email").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("registrationStatus").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("tenantId").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Activates the email registration for current tenant + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for TenantEmailRegistration: +{ + properties: { + activationCode: string, # Required. Activation code for the registration. + activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration. + email: string, # Optional. The email to register. + registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration. + tenantId: string, # Optional. The tenant id to register. + }, # Optional. Tenant email registration property bag. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + +Response Body: + +Schema for TenantEmailRegistration: +{ + properties: { + activationCode: string, # Required. Activation code for the registration. + activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration. + email: string, # Optional. The email to register. + registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration. + tenantId: string, # Optional. The tenant id to register. + }, # Optional. Tenant email registration property bag. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call Activate with required parameters and parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +var data = new {}; + +Response response = client.Activate(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Activate with all parameters and request content, and how to parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +var data = new { + properties = new { + activationCode = "", + }, +}; + +Response response = client.Activate(RequestContent.Create(data), ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("activationCode").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("activationExpiration").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("email").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("registrationStatus").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("tenantId").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Activates the email registration for current tenant + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for TenantEmailRegistration: +{ + properties: { + activationCode: string, # Required. Activation code for the registration. + activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration. + email: string, # Optional. The email to register. + registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration. + tenantId: string, # Optional. The tenant id to register. + }, # Optional. Tenant email registration property bag. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + +Response Body: + +Schema for TenantEmailRegistration: +{ + properties: { + activationCode: string, # Required. Activation code for the registration. + activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration. + email: string, # Optional. The email to register. + registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration. + tenantId: string, # Optional. The tenant id to register. + }, # Optional. Tenant email registration property bag. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call RegisterAsync and parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +Response response = await client.RegisterAsync(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call RegisterAsync with all parameters, and how to parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +Response response = await client.RegisterAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("activationCode").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("activationExpiration").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("email").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("registrationStatus").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("tenantId").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Register an email for the current tenant + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for TenantEmailRegistration: +{ + properties: { + activationCode: string, # Required. Activation code for the registration. + activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration. + email: string, # Optional. The email to register. + registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration. + tenantId: string, # Optional. The tenant id to register. + }, # Optional. Tenant email registration property bag. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call Register and parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +Response response = client.Register(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Register with all parameters, and how to parse the result. +"); +var client = new EmailRegistrationClient(endpoint, credential); + +Response response = client.Register(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("activationCode").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("activationExpiration").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("email").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("registrationStatus").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("tenantId").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Register an email for the current tenant + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for TenantEmailRegistration: +{ + properties: { + activationCode: string, # Required. Activation code for the registration. + activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration. + email: string, # Optional. The email to register. + registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration. + tenantId: string, # Optional. The tenant id to register. + }, # Optional. Tenant email registration property bag. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/EntityClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/EntityClient.xml new file mode 100644 index 000000000000..1f7867e6c24e --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/EntityClient.xml @@ -0,0 +1,6669 @@ + + + + + +This sample shows how to call CreateOrUpdateAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateOrUpdateAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all request content, and how to parse the result. +", credential); + +var data = new { + entity = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = await client.CreateOrUpdateAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call CreateOrUpdate and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateOrUpdate(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all request content, and how to parse the result. +", credential); + +var data = new { + entity = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = client.CreateOrUpdate(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call GetEntitiesByGuidsAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetEntitiesByGuidsAsync(new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetEntitiesByGuidsAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetEntitiesByGuidsAsync(new String[]{""}, true, true, new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call GetEntitiesByGuids with required parameters and parse the result. +", credential); + +Response response = client.GetEntitiesByGuids(new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetEntitiesByGuids with all parameters, and how to parse the result. +", credential); + +Response response = client.GetEntitiesByGuids(new String[]{""}, true, true, new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call CreateOrUpdateEntitiesAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateOrUpdateEntitiesAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateEntitiesAsync with all request content, and how to parse the result. +", credential); + +var data = new { + entities = new[] { + new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = await client.CreateOrUpdateEntitiesAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call CreateOrUpdateEntities and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateOrUpdateEntities(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateEntities with all request content, and how to parse the result. +", credential); + +var data = new { + entities = new[] { + new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = client.CreateOrUpdateEntities(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call DeleteByGuidsAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteByGuidsAsync(new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call DeleteByGuids with required parameters and parse the result. +", credential); + +Response response = client.DeleteByGuids(new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call AddClassificationAsync. +", credential); + +var data = new {}; + +Response response = await client.AddClassificationAsync(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddClassificationAsync with all request content. +", credential); + +var data = new { + classification = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + entityGuids = new[] { + "" + }, +}; + +Response response = await client.AddClassificationAsync(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for ClassificationAssociateRequest: +{ + classification: { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. + entityGuids: [string], # Optional. The GUID of the entity. +} + + + + + + +This sample shows how to call AddClassification. +", credential); + +var data = new {}; + +Response response = client.AddClassification(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddClassification with all request content. +", credential); + +var data = new { + classification = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + entityGuids = new[] { + "" + }, +}; + +Response response = client.AddClassification(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for ClassificationAssociateRequest: +{ + classification: { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. + entityGuids: [string], # Optional. The GUID of the entity. +} + + + + + + +This sample shows how to call GetByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetByGuidAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetByGuidAsync("", true, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entity").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call GetByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetByGuid with all parameters, and how to parse the result. +", credential); + +Response response = client.GetByGuid("", true, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entity").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call PartialUpdateEntityAttributeByGuidAsync with required parameters and request content and parse the result. +", credential); + +var data = new {}; + +Response response = await client.PartialUpdateEntityAttributeByGuidAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call PartialUpdateEntityAttributeByGuid with required parameters and request content and parse the result. +", credential); + +var data = new {}; + +Response response = client.PartialUpdateEntityAttributeByGuid("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call DeleteByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call DeleteByGuid with required parameters and parse the result. +", credential); + +Response response = client.DeleteByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call GetClassificationAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetClassificationAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetClassification with required parameters and parse the result. +", credential); + +Response response = client.GetClassification("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call DeleteClassificationAsync with required parameters. +", credential); + +Response response = await client.DeleteClassificationAsync("", ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteClassification with required parameters. +", credential); + +Response response = client.DeleteClassification("", ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call GetClassificationsAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetClassificationsAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("list")[0].ToString()); +Console.WriteLine(result.GetProperty("pageSize").ToString()); +Console.WriteLine(result.GetProperty("sortBy").ToString()); +Console.WriteLine(result.GetProperty("sortType").ToString()); +Console.WriteLine(result.GetProperty("startIndex").ToString()); +Console.WriteLine(result.GetProperty("totalCount").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassifications: +{ + list: [AnyObject], # Optional. An array of objects. + pageSize: number, # Optional. The size of the page. + sortBy: string, # Optional. The sorted by field. + sortType: "NONE" | "ASC" | "DESC", # Optional. to specify whether the result should be sorted? If yes, whether asc or desc. + startIndex: number, # Optional. The start index of the page. + totalCount: number, # Optional. The total count of items. +} + + + + + + +This sample shows how to call GetClassifications with required parameters and parse the result. +", credential); + +Response response = client.GetClassifications(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("list")[0].ToString()); +Console.WriteLine(result.GetProperty("pageSize").ToString()); +Console.WriteLine(result.GetProperty("sortBy").ToString()); +Console.WriteLine(result.GetProperty("sortType").ToString()); +Console.WriteLine(result.GetProperty("startIndex").ToString()); +Console.WriteLine(result.GetProperty("totalCount").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassifications: +{ + list: [AnyObject], # Optional. An array of objects. + pageSize: number, # Optional. The size of the page. + sortBy: string, # Optional. The sorted by field. + sortType: "NONE" | "ASC" | "DESC", # Optional. to specify whether the result should be sorted? If yes, whether asc or desc. + startIndex: number, # Optional. The start index of the page. + totalCount: number, # Optional. The total count of items. +} + + + + + + +This sample shows how to call AddClassificationsAsync with required parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = await client.AddClassificationsAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call AddClassifications with required parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = client.AddClassifications("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call UpdateClassificationsAsync with required parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = await client.UpdateClassificationsAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call UpdateClassifications with required parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = client.UpdateClassifications("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetByUniqueAttributesAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetByUniqueAttributesAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetByUniqueAttributesAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetByUniqueAttributesAsync("", true, true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entity").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call GetByUniqueAttributes with required parameters and parse the result. +", credential); + +Response response = client.GetByUniqueAttributes(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetByUniqueAttributes with all parameters, and how to parse the result. +", credential); + +Response response = client.GetByUniqueAttributes("", true, true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entity").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entity").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call PartialUpdateEntityByUniqueAttributesAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.PartialUpdateEntityByUniqueAttributesAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call PartialUpdateEntityByUniqueAttributesAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entity = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = await client.PartialUpdateEntityByUniqueAttributesAsync("", RequestContent.Create(data), ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call PartialUpdateEntityByUniqueAttributes with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.PartialUpdateEntityByUniqueAttributes("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call PartialUpdateEntityByUniqueAttributes with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + entity = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + referredEntities = new { + key = new { + businessAttributes = new { + key = new {}, + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + createTime = 123.45f, + createdBy = "", + customAttributes = new { + key = "", + }, + guid = "", + homeId = "", + isIncomplete = true, + labels = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + provenanceType = 123.45f, + proxy = true, + relationshipAttributes = new { + key = new {}, + }, + status = "ACTIVE", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + source = "", + sourceDetails = new { + key = new {}, + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = client.PartialUpdateEntityByUniqueAttributes("", RequestContent.Create(data), ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasEntityWithExtInfo: +{ + entity: { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. An instance of an entity - like hive_table, hive_database. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call DeleteByUniqueAttributeAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteByUniqueAttributeAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call DeleteByUniqueAttributeAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.DeleteByUniqueAttributeAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call DeleteByUniqueAttribute with required parameters and parse the result. +", credential); + +Response response = client.DeleteByUniqueAttribute(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call DeleteByUniqueAttribute with all parameters, and how to parse the result. +", credential); + +Response response = client.DeleteByUniqueAttribute("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("guidAssignments").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("mutatedEntities").GetProperty("")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("partialUpdatedEntities")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for EntityMutationResponse: +{ + guidAssignments: Dictionary<string, string>, # Optional. A map of GUID assignments with entities. + mutatedEntities: Dictionary<string, AtlasEntityHeader[]>, # Optional. The entity headers of mutated entities. + partialUpdatedEntities: [ + { + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity headers that partially updated. +} + + + + + + +This sample shows how to call DeleteClassificationByUniqueAttributeAsync with required parameters. +", credential); + +Response response = await client.DeleteClassificationByUniqueAttributeAsync("", ""); +Console.WriteLine(response.Status); +]]> +This sample shows how to call DeleteClassificationByUniqueAttributeAsync with all parameters. +", credential); + +Response response = await client.DeleteClassificationByUniqueAttributeAsync("", "", ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteClassificationByUniqueAttribute with required parameters. +", credential); + +Response response = client.DeleteClassificationByUniqueAttribute("", ""); +Console.WriteLine(response.Status); +]]> +This sample shows how to call DeleteClassificationByUniqueAttribute with all parameters. +", credential); + +Response response = client.DeleteClassificationByUniqueAttribute("", "", ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddClassificationsByUniqueAttributeAsync with required parameters and request content. +", credential); + +var data = new[] { + new {} +}; + +Response response = await client.AddClassificationsByUniqueAttributeAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddClassificationsByUniqueAttributeAsync with all parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = await client.AddClassificationsByUniqueAttributeAsync("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call AddClassificationsByUniqueAttribute with required parameters and request content. +", credential); + +var data = new[] { + new {} +}; + +Response response = client.AddClassificationsByUniqueAttribute("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddClassificationsByUniqueAttribute with all parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = client.AddClassificationsByUniqueAttribute("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call UpdateClassificationsByUniqueAttributeAsync with required parameters and request content. +", credential); + +var data = new[] { + new {} +}; + +Response response = await client.UpdateClassificationsByUniqueAttributeAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call UpdateClassificationsByUniqueAttributeAsync with all parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = await client.UpdateClassificationsByUniqueAttributeAsync("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call UpdateClassificationsByUniqueAttribute with required parameters and request content. +", credential); + +var data = new[] { + new {} +}; + +Response response = client.UpdateClassificationsByUniqueAttribute("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call UpdateClassificationsByUniqueAttribute with all parameters and request content. +", credential); + +var data = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } +}; + +Response response = client.UpdateClassificationsByUniqueAttribute("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasClassification: +{ + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call SetClassificationsAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.SetClassificationsAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call SetClassificationsAsync with all request content, and how to parse the result. +", credential); + +var data = new { + guidHeaderMap = new { + key = new { + classificationNames = new[] { + "" + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + displayText = "", + guid = "", + isIncomplete = true, + labels = new[] { + "" + }, + meaningNames = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + status = "ACTIVE", + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = await client.SetClassificationsAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasEntityHeaders: +{ + guidHeaderMap: Dictionary<string, AtlasEntityHeader>, # Optional. The description of the guid header map, +} + + + + + + +This sample shows how to call SetClassifications and parse the result. +", credential); + +var data = new {}; + +Response response = client.SetClassifications(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call SetClassifications with all request content, and how to parse the result. +", credential); + +var data = new { + guidHeaderMap = new { + key = new { + classificationNames = new[] { + "" + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + displayText = "", + guid = "", + isIncomplete = true, + labels = new[] { + "" + }, + meaningNames = new[] { + "" + }, + meanings = new[] { + new { + confidence = 1234, + createdBy = "", + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DISCOVERED", + steward = "", + termGuid = "", + } + }, + status = "ACTIVE", + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + }, +}; + +Response response = client.SetClassifications(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasEntityHeaders: +{ + guidHeaderMap: Dictionary<string, AtlasEntityHeader>, # Optional. The description of the guid header map, +} + + + + + + +This sample shows how to call GetEntitiesByUniqueAttributesAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetEntitiesByUniqueAttributesAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetEntitiesByUniqueAttributesAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetEntitiesByUniqueAttributesAsync("", true, true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call GetEntitiesByUniqueAttributes with required parameters and parse the result. +", credential); + +Response response = client.GetEntitiesByUniqueAttributes(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetEntitiesByUniqueAttributes with all parameters, and how to parse the result. +", credential); + +Response response = client.GetEntitiesByUniqueAttributes("", true, true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entities")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("businessAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("customAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("proxy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("relationshipAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntitiesWithExtInfo: +{ + entities: [ + { + businessAttributes: Dictionary<string, AnyObject>, # Optional. Business Attributes + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + customAttributes: Dictionary<string, string>, # Optional. Custom Attribute + guid: string, # Optional. The GUID of the entity. + homeId: string, # Optional. The home ID of the entity. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers indicating the meanings of the entity. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship. + proxy: boolean, # Optional. Determines if there's a proxy. + relationshipAttributes: Dictionary<string, AnyObject>, # Optional. The attributes of relationship. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the entity. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Owner. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entities. + referredEntities: Dictionary<string, AtlasEntity>, # Optional. The referred entities. +} + + + + + + +This sample shows how to call GetHeaderAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetHeaderAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityHeader: +{ + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetHeader with required parameters and parse the result. +", credential); + +Response response = client.GetHeader(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityHeader: +{ + classificationNames: [string], # Optional. An array of classification names. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + displayText: string, # Optional. The display text. + guid: string, # Optional. The GUID of the record. + isIncomplete: boolean, # Optional. Whether it is a shell entity + labels: [string], # Optional. labels + meaningNames: [string], # Optional. An array of meanings. + meanings: [ + { + confidence: number, # Optional. The confidence of the term assignment. + createdBy: string, # Optional. The user who created the record. + description: string, # Optional. The description of the term assignment. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term assignment. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of terms assignment. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of term assignment headers. + status: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call DeleteBusinessMetadataAsync with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = await client.DeleteBusinessMetadataAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteBusinessMetadata with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = client.DeleteBusinessMetadata("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddOrUpdateBusinessMetadataAsync with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = await client.AddOrUpdateBusinessMetadataAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddOrUpdateBusinessMetadataAsync with all parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = await client.AddOrUpdateBusinessMetadataAsync("", RequestContent.Create(data), true); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddOrUpdateBusinessMetadata with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = client.AddOrUpdateBusinessMetadata("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddOrUpdateBusinessMetadata with all parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = client.AddOrUpdateBusinessMetadata("", RequestContent.Create(data), true); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteBusinessMetadataAttributesAsync with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = await client.DeleteBusinessMetadataAttributesAsync("", "", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteBusinessMetadataAttributes with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = client.DeleteBusinessMetadataAttributes("", "", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddOrUpdateBusinessMetadataAttributesAsync with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = await client.AddOrUpdateBusinessMetadataAttributesAsync("", "", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddOrUpdateBusinessMetadataAttributes with required parameters and request content. +", credential); + +var data = new { + key = new {}, +}; + +Response response = client.AddOrUpdateBusinessMetadataAttributes("", "", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call GetSampleBusinessMetadataTemplateAsync and parse the result. +", credential); + +Response response = await client.GetSampleBusinessMetadataTemplateAsync(); +if (response.ContentStream != null) +{ + using(Stream outFileStream = File.OpenWrite("") + { + response.ContentStream.CopyTo(outFileStream); + } +} +]]> + + + + +This sample shows how to call GetSampleBusinessMetadataTemplate and parse the result. +", credential); + +Response response = client.GetSampleBusinessMetadataTemplate(); +if (response.ContentStream != null) +{ + using(Stream outFileStream = File.OpenWrite("") + { + response.ContentStream.CopyTo(outFileStream); + } +} +]]> + + + + +This sample shows how to call ImportBusinessMetadataAsync with required request content and parse the result. +", credential); + +var data = File.OpenRead(""); + +Response response = await client.ImportBusinessMetadataAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("childObjectName").ToString()); +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("importStatus").ToString()); +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("parentObjectName").ToString()); +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("remarks").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("childObjectName").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("importStatus").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("parentObjectName").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("remarks").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for BulkImportResponse: +{ + failedImportInfoList: [ + { + childObjectName: string, # Optional. childObjectName + importStatus: "SUCCESS" | "FAILED", # Optional. importStatus + parentObjectName: string, # Optional. parentObjectName + remarks: string, # Optional. remarks + } + ], # Optional. failed importInfoList + successImportInfoList: [ImportInfo], # Optional. successful importInfoList +} + + + + + + +This sample shows how to call ImportBusinessMetadata with required request content and parse the result. +", credential); + +var data = File.OpenRead(""); + +Response response = client.ImportBusinessMetadata(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("childObjectName").ToString()); +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("importStatus").ToString()); +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("parentObjectName").ToString()); +Console.WriteLine(result.GetProperty("failedImportInfoList")[0].GetProperty("remarks").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("childObjectName").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("importStatus").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("parentObjectName").ToString()); +Console.WriteLine(result.GetProperty("successImportInfoList")[0].GetProperty("remarks").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for BulkImportResponse: +{ + failedImportInfoList: [ + { + childObjectName: string, # Optional. childObjectName + importStatus: "SUCCESS" | "FAILED", # Optional. importStatus + parentObjectName: string, # Optional. parentObjectName + remarks: string, # Optional. remarks + } + ], # Optional. failed importInfoList + successImportInfoList: [ImportInfo], # Optional. successful importInfoList +} + + + + + + +This sample shows how to call DeleteLabelsAsync with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.DeleteLabelsAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteLabels with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.DeleteLabels("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call SetLabelsAsync with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.SetLabelsAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call SetLabels with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.SetLabels("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddLabelAsync with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.AddLabelAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddLabel with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.AddLabel("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteLabelsByUniqueAttributeAsync with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.DeleteLabelsByUniqueAttributeAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call DeleteLabelsByUniqueAttributeAsync with all parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.DeleteLabelsByUniqueAttributeAsync("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteLabelsByUniqueAttribute with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.DeleteLabelsByUniqueAttribute("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call DeleteLabelsByUniqueAttribute with all parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.DeleteLabelsByUniqueAttribute("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call SetLabelsByUniqueAttributeAsync with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.SetLabelsByUniqueAttributeAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call SetLabelsByUniqueAttributeAsync with all parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.SetLabelsByUniqueAttributeAsync("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call SetLabelsByUniqueAttribute with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.SetLabelsByUniqueAttribute("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call SetLabelsByUniqueAttribute with all parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.SetLabelsByUniqueAttribute("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddLabelsByUniqueAttributeAsync with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.AddLabelsByUniqueAttributeAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddLabelsByUniqueAttributeAsync with all parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.AddLabelsByUniqueAttributeAsync("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call AddLabelsByUniqueAttribute with required parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.AddLabelsByUniqueAttribute("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call AddLabelsByUniqueAttribute with all parameters and request content. +", credential); + +var data = new[] { + "" +}; + +Response response = client.AddLabelsByUniqueAttribute("", RequestContent.Create(data), ""); +Console.WriteLine(response.Status); +]]> + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/FiltersClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/FiltersClient.xml new file mode 100644 index 000000000000..721f74598fc3 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/FiltersClient.xml @@ -0,0 +1,213 @@ + + + + + +This sample shows how to call GetFilterAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetFilterAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("excludeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("includeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for Filter: +{ + properties: { + excludeUriPrefixes: [string], # Optional. + includeUriPrefixes: [string], # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetFilter with required parameters and parse the result. +", credential); + +Response response = client.GetFilter("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("excludeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("includeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for Filter: +{ + properties: { + excludeUriPrefixes: [string], # Optional. + includeUriPrefixes: [string], # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateOrUpdateAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + excludeUriPrefixes = new[] { + "" + }, + includeUriPrefixes = new[] { + "" + }, + }, +}; + +Response response = await client.CreateOrUpdateAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("excludeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("includeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for Filter: +{ + properties: { + excludeUriPrefixes: [string], # Optional. + includeUriPrefixes: [string], # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + +Response Body: + +Schema for Filter: +{ + properties: { + excludeUriPrefixes: [string], # Optional. + includeUriPrefixes: [string], # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call CreateOrUpdate with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateOrUpdate("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + excludeUriPrefixes = new[] { + "" + }, + includeUriPrefixes = new[] { + "" + }, + }, +}; + +Response response = client.CreateOrUpdate("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("excludeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("includeUriPrefixes")[0].ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for Filter: +{ + properties: { + excludeUriPrefixes: [string], # Optional. + includeUriPrefixes: [string], # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + +Response Body: + +Schema for Filter: +{ + properties: { + excludeUriPrefixes: [string], # Optional. + includeUriPrefixes: [string], # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/GlossaryClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/GlossaryClient.xml new file mode 100644 index 000000000000..59ea085e8802 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/GlossaryClient.xml @@ -0,0 +1,13555 @@ + + + + + +This sample shows how to call GetGlossariesAsync and parse the result. +", credential); + +Response response = await client.GetGlossariesAsync(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossariesAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetGlossariesAsync(1234, 1234, "", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("language").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call GetGlossaries and parse the result. +", credential); + +Response response = client.GetGlossaries(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaries with all parameters, and how to parse the result. +", credential); + +Response response = client.GetGlossaries(1234, 1234, "", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("language").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call CreateGlossaryAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateGlossaryAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateGlossaryAsync with all request content, and how to parse the result. +", credential); + +var data = new { + categoryInfo = new { + key = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + termInfo = new { + key = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + language = "", + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = await client.CreateGlossaryAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call CreateGlossary and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateGlossary(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateGlossary with all request content, and how to parse the result. +", credential); + +var data = new { + categoryInfo = new { + key = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + termInfo = new { + key = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + language = "", + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = client.CreateGlossary(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call CreateGlossaryCategoriesAsync with required request content and parse the result. +", credential); + +var data = new[] { + new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + } +}; + +Response response = await client.CreateGlossaryCategoriesAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call CreateGlossaryCategories with required request content and parse the result. +", credential); + +var data = new[] { + new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + } +}; + +Response response = client.CreateGlossaryCategories(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call CreateGlossaryCategoryAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateGlossaryCategoryAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateGlossaryCategoryAsync with all request content, and how to parse the result. +", credential); + +var data = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = await client.CreateGlossaryCategoryAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call CreateGlossaryCategory and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateGlossaryCategory(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateGlossaryCategory with all request content, and how to parse the result. +", credential); + +var data = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = client.CreateGlossaryCategory(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryCategoryAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetGlossaryCategoryAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryCategory with required parameters and parse the result. +", credential); + +Response response = client.GetGlossaryCategory(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call UpdateGlossaryCategoryAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.UpdateGlossaryCategoryAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateGlossaryCategoryAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = await client.UpdateGlossaryCategoryAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call UpdateGlossaryCategory with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.UpdateGlossaryCategory("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateGlossaryCategory with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = client.UpdateGlossaryCategory("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call DeleteGlossaryCategoryAsync with required parameters. +", credential); + +Response response = await client.DeleteGlossaryCategoryAsync(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteGlossaryCategory with required parameters. +", credential); + +Response response = client.DeleteGlossaryCategory(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call PartialUpdateGlossaryCategoryAsync with required parameters and request content and parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = await client.PartialUpdateGlossaryCategoryAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call PartialUpdateGlossaryCategory with required parameters and request content and parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = client.PartialUpdateGlossaryCategory("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetRelatedCategoriesAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetRelatedCategoriesAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].ToString()); +]]> +This sample shows how to call GetRelatedCategoriesAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetRelatedCategoriesAsync("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("relationGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedCategoryHeader: +{ + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. +} + + + + + + +This sample shows how to call GetRelatedCategories with required parameters and parse the result. +", credential); + +Response response = client.GetRelatedCategories(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].ToString()); +]]> +This sample shows how to call GetRelatedCategories with all parameters, and how to parse the result. +", credential); + +Response response = client.GetRelatedCategories("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("relationGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedCategoryHeader: +{ + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. +} + + + + + + +This sample shows how to call GetCategoryTermsAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetCategoryTermsAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetCategoryTermsAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetCategoryTermsAsync("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("termGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedTermHeader: +{ + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. +} + + + + + + +This sample shows how to call GetCategoryTerms with required parameters and parse the result. +", credential); + +Response response = client.GetCategoryTerms(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetCategoryTerms with all parameters, and how to parse the result. +", credential); + +Response response = client.GetCategoryTerms("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("termGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedTermHeader: +{ + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. +} + + + + + + +This sample shows how to call CreateGlossaryTermAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateGlossaryTermAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateGlossaryTermAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = await client.CreateGlossaryTermAsync(RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call CreateGlossaryTerm with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateGlossaryTerm(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateGlossaryTerm with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = client.CreateGlossaryTerm(RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryTermAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetGlossaryTermAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetGlossaryTermAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetGlossaryTermAsync("", true, new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryTerm with required parameters and parse the result. +", credential); + +Response response = client.GetGlossaryTerm(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetGlossaryTerm with all parameters, and how to parse the result. +", credential); + +Response response = client.GetGlossaryTerm("", true, new String[]{""}); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call UpdateGlossaryTermAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.UpdateGlossaryTermAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateGlossaryTermAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = await client.UpdateGlossaryTermAsync("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call UpdateGlossaryTerm with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.UpdateGlossaryTerm("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateGlossaryTerm with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = client.UpdateGlossaryTerm("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call DeleteGlossaryTermAsync with required parameters. +", credential); + +Response response = await client.DeleteGlossaryTermAsync(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteGlossaryTerm with required parameters. +", credential); + +Response response = client.DeleteGlossaryTerm(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call PartialUpdateGlossaryTermAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = await client.PartialUpdateGlossaryTermAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call PartialUpdateGlossaryTermAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = await client.PartialUpdateGlossaryTermAsync("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call PartialUpdateGlossaryTerm with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = client.PartialUpdateGlossaryTerm("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call PartialUpdateGlossaryTerm with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = client.PartialUpdateGlossaryTerm("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call CreateGlossaryTermsAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + new {} +}; + +Response response = await client.CreateGlossaryTermsAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call CreateGlossaryTermsAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + } +}; + +Response response = await client.CreateGlossaryTermsAsync(RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("abbreviation").ToString()); +Console.WriteLine(result[0].GetProperty("templateName")[0].ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("createTime").ToString()); +Console.WriteLine(result[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result[0].GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("examples")[0].ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call CreateGlossaryTerms with required parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + new {} +}; + +Response response = client.CreateGlossaryTerms(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call CreateGlossaryTerms with all parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + } +}; + +Response response = client.CreateGlossaryTerms(RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("abbreviation").ToString()); +Console.WriteLine(result[0].GetProperty("templateName")[0].ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("createTime").ToString()); +Console.WriteLine(result[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result[0].GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("examples")[0].ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetEntitiesAssignedWithTermAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetEntitiesAssignedWithTermAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetEntitiesAssignedWithTermAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetEntitiesAssignedWithTermAsync("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call GetEntitiesAssignedWithTerm with required parameters and parse the result. +", credential); + +Response response = client.GetEntitiesAssignedWithTerm(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetEntitiesAssignedWithTerm with all parameters, and how to parse the result. +", credential); + +Response response = client.GetEntitiesAssignedWithTerm("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call AssignTermToEntitiesAsync with required parameters and request content. +", credential); + +var data = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } +}; + +Response response = await client.AssignTermToEntitiesAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call AssignTermToEntities with required parameters and request content. +", credential); + +var data = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } +}; + +Response response = client.AssignTermToEntities("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call RemoveTermAssignmentFromEntitiesAsync with required parameters and request content. +", credential); + +var data = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } +}; + +Response response = await client.RemoveTermAssignmentFromEntitiesAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call RemoveTermAssignmentFromEntities with required parameters and request content. +", credential); + +var data = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } +}; + +Response response = client.RemoveTermAssignmentFromEntities("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call DeleteTermAssignmentFromEntitiesAsync with required parameters and request content. +", credential); + +var data = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } +}; + +Response response = await client.DeleteTermAssignmentFromEntitiesAsync("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call DeleteTermAssignmentFromEntities with required parameters and request content. +", credential); + +var data = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } +}; + +Response response = client.DeleteTermAssignmentFromEntities("", RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasRelatedObjectId: +{ + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. +} + + + + + + +This sample shows how to call GetRelatedTermsAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetRelatedTermsAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].ToString()); +]]> +This sample shows how to call GetRelatedTermsAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetRelatedTermsAsync("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("termGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedTermHeader: +{ + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. +} + + + + + + +This sample shows how to call GetRelatedTerms with required parameters and parse the result. +", credential); + +Response response = client.GetRelatedTerms(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].ToString()); +]]> +This sample shows how to call GetRelatedTerms with all parameters, and how to parse the result. +", credential); + +Response response = client.GetRelatedTerms("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("")[0].GetProperty("termGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedTermHeader: +{ + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. +} + + + + + + +This sample shows how to call GetGlossaryAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetGlossaryAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call GetGlossary with required parameters and parse the result. +", credential); + +Response response = client.GetGlossary(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call UpdateGlossaryAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.UpdateGlossaryAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateGlossaryAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + categoryInfo = new { + key = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + termInfo = new { + key = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + language = "", + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = await client.UpdateGlossaryAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call UpdateGlossary with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.UpdateGlossary("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateGlossary with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + categoryInfo = new { + key = new { + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + childrenCategories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + parentCategory = new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + }, + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + termInfo = new { + key = new { + abbreviation = "", + templateName = new[] { + new {} + }, + anchor = new { + displayText = "", + glossaryGuid = "", + relationGuid = "", + }, + antonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + createTime = 123.45f, + createdBy = "", + updateTime = 123.45f, + updatedBy = "", + status = "Draft", + resources = new[] { + new { + displayName = "", + url = "", + } + }, + contacts = new { + key = new[] { + new { + id = "", + info = "", + } + }, + }, + attributes = new { + key = new { + key = new {}, + }, + }, + assignedEntities = new[] { + new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + } + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + relationGuid = "", + status = "DRAFT", + } + }, + classifies = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + examples = new[] { + "" + }, + isA = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + preferredToTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacedBy = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + replacementTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + seeAlso = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + synonyms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translatedTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + translationTerms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + validValues = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + validValuesFor = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", + }, + }, + categories = new[] { + new { + categoryGuid = "", + description = "", + displayText = "", + parentCategoryGuid = "", + relationGuid = "", + } + }, + language = "", + terms = new[] { + new { + description = "", + displayText = "", + expression = "", + relationGuid = "", + source = "", + status = "DRAFT", + steward = "", + termGuid = "", + } + }, + usage = "", + classifications = new[] { + new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + } + }, + longDescription = "", + name = "", + qualifiedName = "", + shortDescription = "", + lastModifiedTS = "", + guid = "", +}; + +Response response = client.UpdateGlossary("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call DeleteGlossaryAsync with required parameters. +", credential); + +Response response = await client.DeleteGlossaryAsync(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteGlossary with required parameters. +", credential); + +Response response = client.DeleteGlossary(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call GetGlossaryCategoriesAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetGlossaryCategoriesAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryCategoriesAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetGlossaryCategoriesAsync("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryCategories with required parameters and parse the result. +", credential); + +Response response = client.GetGlossaryCategories(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryCategories with all parameters, and how to parse the result. +", credential); + +Response response = client.GetGlossaryCategories("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryCategory: +{ + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + childrenCategories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of children categories. + parentCategory: AtlasRelatedCategoryHeader, # Optional. The header of the related category. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryCategoriesHeadersAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetGlossaryCategoriesHeadersAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryCategoriesHeadersAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetGlossaryCategoriesHeadersAsync("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("relationGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedCategoryHeader: +{ + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. +} + + + + + + +This sample shows how to call GetGlossaryCategoriesHeaders with required parameters and parse the result. +", credential); + +Response response = client.GetGlossaryCategoriesHeaders(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryCategoriesHeaders with all parameters, and how to parse the result. +", credential); + +Response response = client.GetGlossaryCategoriesHeaders("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("relationGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedCategoryHeader: +{ + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. +} + + + + + + +This sample shows how to call GetDetailedGlossaryAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetDetailedGlossaryAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetDetailedGlossaryAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetDetailedGlossaryAsync("", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetDetailedGlossary with required parameters and parse the result. +", credential); + +Response response = client.GetDetailedGlossary(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetDetailedGlossary with all parameters, and how to parse the result. +", credential); + +Response response = client.GetDetailedGlossary("", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("parentCategory").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("categoryInfo").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("abbreviation").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("templateName")[0].ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("examples")[0].ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termInfo").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call PartialUpdateGlossaryAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = await client.PartialUpdateGlossaryAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call PartialUpdateGlossaryAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = await client.PartialUpdateGlossaryAsync("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call PartialUpdateGlossary with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = client.PartialUpdateGlossary("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call PartialUpdateGlossary with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + key = "", +}; + +Response response = client.PartialUpdateGlossary("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString()); +Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("language").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("longDescription").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("qualifiedName").ToString()); +Console.WriteLine(result.GetProperty("shortDescription").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +
AtlasGlossaryExtInfoSchema for AtlasGlossaryExtInfo: +{ + categoryInfo: Dictionary<string, AtlasGlossaryCategory>, # Optional. The glossary category information. + termInfo: Dictionary<string, AtlasGlossaryTerm>, # Optional. The glossary term information. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the category header. + displayText: string, # Optional. The display text. + parentCategoryGuid: string, # Optional. The GUID of the parent category. + relationGuid: string, # Optional. The GUID of the relationship. + } + ], # Optional. An array of categories. + language: string, # Optional. The language of the glossary. + terms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers. + usage: string, # Optional. The usage of the glossary. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + +
+ + + + + +This sample shows how to call GetGlossaryTermsAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetGlossaryTermsAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryTermsAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetGlossaryTermsAsync("", true, 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("abbreviation").ToString()); +Console.WriteLine(result[0].GetProperty("templateName")[0].ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("createTime").ToString()); +Console.WriteLine(result[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result[0].GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("examples")[0].ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryTerms with required parameters and parse the result. +", credential); + +Response response = client.GetGlossaryTerms(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryTerms with all parameters, and how to parse the result. +", credential); + +Response response = client.GetGlossaryTerms("", true, 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("abbreviation").ToString()); +Console.WriteLine(result[0].GetProperty("templateName")[0].ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("createTime").ToString()); +Console.WriteLine(result[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result[0].GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("examples")[0].ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetGlossaryTermHeadersAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetGlossaryTermHeadersAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryTermHeadersAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetGlossaryTermHeadersAsync("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("termGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedTermHeader: +{ + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. +} + + + + + + +This sample shows how to call GetGlossaryTermHeaders with required parameters and parse the result. +", credential); + +Response response = client.GetGlossaryTermHeaders(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetGlossaryTermHeaders with all parameters, and how to parse the result. +", credential); + +Response response = client.GetGlossaryTermHeaders("", 1234, 1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("termGuid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelatedTermHeader: +{ + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. +} + + + + + + +This sample shows how to call GetImportCsvOperationStatusAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetImportCsvOperationStatusAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("lastUpdateTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("importedTerms").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("totalTermsDetected").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorCode").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorMessage").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for ImportCSVOperation: +{ + id: string, # Optional. guid string + status: "NotStarted" | "Succeeded" | "Failed" | "Running", # Optional. Enum of the status of import csv operation. + createTime: string, # Optional. The created time of the record. + lastUpdateTime: string, # Optional. The last updated time of the record. + properties: { + importedTerms: string, # Optional. Term numbers that already imported successfully + totalTermsDetected: string, # Optional. Total term numbers that detected in csv + }, # Optional. + error: { + errorCode: number, # Optional. Error code from async import job if fail + errorMessage: string, # Optional. Error message from async import job if fail + }, # Optional. +} + + + + + + +This sample shows how to call GetImportCsvOperationStatus with required parameters and parse the result. +", credential); + +Response response = client.GetImportCsvOperationStatus(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("lastUpdateTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("importedTerms").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("totalTermsDetected").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorCode").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorMessage").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for ImportCSVOperation: +{ + id: string, # Optional. guid string + status: "NotStarted" | "Succeeded" | "Failed" | "Running", # Optional. Enum of the status of import csv operation. + createTime: string, # Optional. The created time of the record. + lastUpdateTime: string, # Optional. The last updated time of the record. + properties: { + importedTerms: string, # Optional. Term numbers that already imported successfully + totalTermsDetected: string, # Optional. Total term numbers that detected in csv + }, # Optional. + error: { + errorCode: number, # Optional. Error code from async import job if fail + errorMessage: string, # Optional. Error message from async import job if fail + }, # Optional. +} + + + + + + +This sample shows how to call ExportGlossaryTermsAsCsvAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.ExportGlossaryTermsAsCsvAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ExportGlossaryTermsAsCsvAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + "" +}; + +Response response = await client.ExportGlossaryTermsAsCsvAsync("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> + + + + +This sample shows how to call ExportGlossaryTermsAsCsv with required parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + "" +}; + +Response response = client.ExportGlossaryTermsAsCsv("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ExportGlossaryTermsAsCsv with all parameters and request content, and how to parse the result. +", credential); + +var data = new[] { + "" +}; + +Response response = client.ExportGlossaryTermsAsCsv("", RequestContent.Create(data), true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> + + + + +This sample shows how to call GetTermsByGlossaryNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetTermsByGlossaryNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetTermsByGlossaryNameAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetTermsByGlossaryNameAsync("", 1234, 1234, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("abbreviation").ToString()); +Console.WriteLine(result[0].GetProperty("templateName")[0].ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("createTime").ToString()); +Console.WriteLine(result[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result[0].GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("examples")[0].ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call GetTermsByGlossaryName with required parameters and parse the result. +", credential); + +Response response = client.GetTermsByGlossaryName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetTermsByGlossaryName with all parameters, and how to parse the result. +", credential); + +Response response = client.GetTermsByGlossaryName("", 1234, 1234, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("abbreviation").ToString()); +Console.WriteLine(result[0].GetProperty("templateName")[0].ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("antonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("createTime").ToString()); +Console.WriteLine(result[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("displayName").ToString()); +Console.WriteLine(result[0].GetProperty("resources")[0].GetProperty("url").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("id").ToString()); +Console.WriteLine(result[0].GetProperty("contacts").GetProperty("")[0].GetProperty("info").ToString()); +Console.WriteLine(result[0].GetProperty("attributes").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipType").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipAttributes").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipGuid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("relationshipStatus").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("assignedEntities")[0].GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("categoryGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("classifies")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("examples")[0].ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("isA")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("preferredToTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacedBy")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("replacementTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("seeAlso")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("synonyms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translatedTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("translationTerms")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("usage").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValues")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("description").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("expression").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("status").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("steward").ToString()); +Console.WriteLine(result[0].GetProperty("validValuesFor")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("longDescription").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +Console.WriteLine(result[0].GetProperty("qualifiedName").ToString()); +Console.WriteLine(result[0].GetProperty("shortDescription").ToString()); +Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasGlossaryTerm: +{ + abbreviation: string, # Optional. The abbreviation of the term. + templateName: [AnyObject], # Optional. + anchor: { + displayText: string, # Optional. The display text. + glossaryGuid: string, # Optional. The GUID of the glossary. + relationGuid: string, # Optional. The GUID of the relationship. + }, # Optional. The glossary header with basic information. + antonyms: [ + { + description: string, # Optional. The description of the related term. + displayText: string, # Optional. The display text. + expression: string, # Optional. The expression of the term. + relationGuid: string, # Optional. The GUID of the relationship. + source: string, # Optional. The source of the term. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + steward: string, # Optional. The steward of the term. + termGuid: string, # Optional. The GUID of the term. + } + ], # Optional. An array of related term headers as antonyms. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + status: "Draft" | "Approved" | "Alert" | "Expired", # Optional. Status of the AtlasGlossaryTerm + resources: [ + { + displayName: string, # Optional. Display name for url. + url: string, # Optional. web url. http or https + } + ], # Optional. An array of resource link for term + contacts: Dictionary<string, ContactBasic[]>, # Optional. The dictionary of contacts for terms. Key could be Expert or Steward. + attributes: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The custom attributes of the term, which is map<string,map<string,object>>. +The key of the first layer map is term template name. + assignedEntities: [ + { + displayText: string, # Optional. The display text. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + relationshipType: string, # Optional. + relationshipAttributes: { + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. + relationshipGuid: string, # Optional. The GUID of the relationship. + relationshipStatus: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + } + ], # Optional. An array of related object IDs. + categories: [ + { + categoryGuid: string, # Optional. The GUID of the category. + description: string, # Optional. The description of the record. + displayText: string, # Optional. The display text. + relationGuid: string, # Optional. The GUID of the relationship. + status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER", # Optional. The status of term relationship. + } + ], # Optional. An array of term categorization headers. + classifies: [AtlasRelatedTermHeader], # Optional. An array of related term headers. + examples: [string], # Optional. An array of examples. + isA: [AtlasRelatedTermHeader], # Optional. An array of related term headers indicating the is-a relationship. + preferredTerms: [AtlasRelatedTermHeader], # Optional. An array of preferred related term headers. + preferredToTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are preferred to. + replacedBy: [AtlasRelatedTermHeader], # Optional. An array of related term headers that are replaced by. + replacementTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for replacement. + seeAlso: [AtlasRelatedTermHeader], # Optional. An array of related term headers for see also. + synonyms: [AtlasRelatedTermHeader], # Optional. An array of related term headers as synonyms. + translatedTerms: [AtlasRelatedTermHeader], # Optional. An array of translated related term headers. + translationTerms: [AtlasRelatedTermHeader], # Optional. An array of related term headers for translation. + usage: string, # Optional. The usage of the term. + validValues: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values. + validValuesFor: [AtlasRelatedTermHeader], # Optional. An array of related term headers as valid values for other records. + classifications: [ + { + entityGuid: string, # Optional. The GUID of the entity. + entityStatus: "ACTIVE" | "DELETED", # Optional. Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store. + removePropagationsOnEntityDelete: boolean, # Optional. Determines if propagations will be removed on entity deletion. + validityPeriods: [ + { + endTime: string, # Optional. The end of the time boundary. + startTime: string, # Optional. The start of the time boundary. + timeZone: string, # Optional. The timezone of the time boundary. + } + ], # Optional. An array of time boundaries indicating validity periods. + source: string, # Optional. indicate the source who create the classification detail + sourceDetails: Dictionary<string, AnyObject>, # Optional. more detail on source information + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classifications. + longDescription: string, # Optional. The long version description. + name: string, # Optional. The name of the glossary object. + qualifiedName: string, # Optional. The qualified name of the glossary object. + shortDescription: string, # Optional. The short version of description. + lastModifiedTS: string, # Optional. ETag for concurrency control. + guid: string, # Optional. The GUID of the object. +} + + + + + + +This sample shows how to call ImportGlossaryTermsViaCsvAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = await client.ImportGlossaryTermsViaCsvAsync(WaitUntil.Completed, "", RequestContent.Create(data)); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ImportGlossaryTermsViaCsvAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = await client.ImportGlossaryTermsViaCsvAsync(WaitUntil.Completed, "", RequestContent.Create(data), true); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("lastUpdateTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("importedTerms").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("totalTermsDetected").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorCode").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorMessage").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for ImportCSVOperation: +{ + id: string, # Optional. guid string + status: "NotStarted" | "Succeeded" | "Failed" | "Running", # Optional. Enum of the status of import csv operation. + createTime: string, # Optional. The created time of the record. + lastUpdateTime: string, # Optional. The last updated time of the record. + properties: { + importedTerms: string, # Optional. Term numbers that already imported successfully + totalTermsDetected: string, # Optional. Total term numbers that detected in csv + }, # Optional. + error: { + errorCode: number, # Optional. Error code from async import job if fail + errorMessage: string, # Optional. Error message from async import job if fail + }, # Optional. +} + + + + + + +This sample shows how to call ImportGlossaryTermsViaCsv with required parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = client.ImportGlossaryTermsViaCsv(WaitUntil.Completed, "", RequestContent.Create(data)); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ImportGlossaryTermsViaCsv with all parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = client.ImportGlossaryTermsViaCsv(WaitUntil.Completed, "", RequestContent.Create(data), true); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("lastUpdateTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("importedTerms").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("totalTermsDetected").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorCode").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorMessage").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for ImportCSVOperation: +{ + id: string, # Optional. guid string + status: "NotStarted" | "Succeeded" | "Failed" | "Running", # Optional. Enum of the status of import csv operation. + createTime: string, # Optional. The created time of the record. + lastUpdateTime: string, # Optional. The last updated time of the record. + properties: { + importedTerms: string, # Optional. Term numbers that already imported successfully + totalTermsDetected: string, # Optional. Total term numbers that detected in csv + }, # Optional. + error: { + errorCode: number, # Optional. Error code from async import job if fail + errorMessage: string, # Optional. Error message from async import job if fail + }, # Optional. +} + + + + + + +This sample shows how to call ImportGlossaryTermsViaCsvByGlossaryNameAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = await client.ImportGlossaryTermsViaCsvByGlossaryNameAsync(WaitUntil.Completed, "", RequestContent.Create(data)); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ImportGlossaryTermsViaCsvByGlossaryNameAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = await client.ImportGlossaryTermsViaCsvByGlossaryNameAsync(WaitUntil.Completed, "", RequestContent.Create(data), true); + +BinaryData data = await operation.WaitForCompletionAsync(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("lastUpdateTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("importedTerms").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("totalTermsDetected").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorCode").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorMessage").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for ImportCSVOperation: +{ + id: string, # Optional. guid string + status: "NotStarted" | "Succeeded" | "Failed" | "Running", # Optional. Enum of the status of import csv operation. + createTime: string, # Optional. The created time of the record. + lastUpdateTime: string, # Optional. The last updated time of the record. + properties: { + importedTerms: string, # Optional. Term numbers that already imported successfully + totalTermsDetected: string, # Optional. Total term numbers that detected in csv + }, # Optional. + error: { + errorCode: number, # Optional. Error code from async import job if fail + errorMessage: string, # Optional. Error message from async import job if fail + }, # Optional. +} + + + + + + +This sample shows how to call ImportGlossaryTermsViaCsvByGlossaryName with required parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = client.ImportGlossaryTermsViaCsvByGlossaryName(WaitUntil.Completed, "", RequestContent.Create(data)); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call ImportGlossaryTermsViaCsvByGlossaryName with all parameters and request content, and how to parse the result. +", credential); + +var data = File.OpenRead(""); + +var operation = client.ImportGlossaryTermsViaCsvByGlossaryName(WaitUntil.Completed, "", RequestContent.Create(data), true); + +BinaryData data = operation.WaitForCompletion(); +JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("lastUpdateTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("importedTerms").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("totalTermsDetected").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorCode").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("errorMessage").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for ImportCSVOperation: +{ + id: string, # Optional. guid string + status: "NotStarted" | "Succeeded" | "Failed" | "Running", # Optional. Enum of the status of import csv operation. + createTime: string, # Optional. The created time of the record. + lastUpdateTime: string, # Optional. The last updated time of the record. + properties: { + importedTerms: string, # Optional. Term numbers that already imported successfully + totalTermsDetected: string, # Optional. Total term numbers that detected in csv + }, # Optional. + error: { + errorCode: number, # Optional. Error code from async import job if fail + errorMessage: string, # Optional. Error message from async import job if fail + }, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/KeyVaultConnectionsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/KeyVaultConnectionsClient.xml new file mode 100644 index 000000000000..0608a40a4ed7 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/KeyVaultConnectionsClient.xml @@ -0,0 +1,343 @@ + + + + + +This sample shows how to call GetKeyVaultConnectionAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetKeyVaultConnectionAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetKeyVaultConnection with required parameters and parse the result. +", credential); + +Response response = client.GetKeyVaultConnection(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call CreateAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + baseUrl = "", + description = "", + }, +}; + +Response response = await client.CreateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + +Response Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call Create with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.Create("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Create with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + baseUrl = "", + description = "", + }, +}; + +Response response = client.Create("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + +Response Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call DeleteAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call Delete with required parameters and parse the result. +", credential); + +Response response = client.Delete(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AzureKeyVault: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetKeyVaultConnectionsAsync and parse the result. +", credential); + +await foreach (var data in client.GetKeyVaultConnectionsAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AzureKeyVaultListValue: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetKeyVaultConnections and parse the result. +", credential); + +foreach (var data in client.GetKeyVaultConnections()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("properties").GetProperty("baseUrl").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for AzureKeyVaultListValue: +{ + properties: { + baseUrl: string, # Optional. + description: string, # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/LineageClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/LineageClient.xml new file mode 100644 index 000000000000..eb1622ec07a9 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/LineageClient.xml @@ -0,0 +1,605 @@ + + + + + +This sample shows how to call GetLineageGraphAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetLineageGraphAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetLineageGraphAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetLineageGraphAsync("", "", 1234, 1234, true, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("baseEntityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("widthCounts").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("lineageDepth").ToString()); +Console.WriteLine(result.GetProperty("lineageWidth").ToString()); +Console.WriteLine(result.GetProperty("includeParent").ToString()); +Console.WriteLine(result.GetProperty("childrenCount").ToString()); +Console.WriteLine(result.GetProperty("lineageDirection").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("childEntityId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("parentEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("fromEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("toEntityId").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasLineageInfo: +{ + baseEntityGuid: string, # Optional. The GUID of the base entity. + guidEntityMap: Dictionary<string, AtlasEntityHeader>, # Optional. The GUID entity map. + widthCounts: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The entity count in specific direction. + lineageDepth: number, # Optional. The depth of lineage. + lineageWidth: number, # Optional. The width of lineage. + includeParent: boolean, # Optional. True to return the parent of the base entity. + childrenCount: number, # Optional. The number of children node. + lineageDirection: "INPUT" | "OUTPUT" | "BOTH", # Optional. The enum of lineage direction. + parentRelations: [ + { + childEntityId: string, # Optional. The GUID of child entity. + relationshipId: string, # Optional. The GUID of relationship. + parentEntityId: string, # Optional. The GUID of parent entity. + } + ], # Optional. An array of parentRelations relations. + relations: [ + { + fromEntityId: string, # Optional. The GUID of from-entity. + relationshipId: string, # Optional. The GUID of relationship. + toEntityId: string, # Optional. The GUID of to-entity. + } + ], # Optional. An array of lineage relations. +} + + + + + + +This sample shows how to call GetLineageGraph with required parameters and parse the result. +", credential); + +Response response = client.GetLineageGraph("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetLineageGraph with all parameters, and how to parse the result. +", credential); + +Response response = client.GetLineageGraph("", "", 1234, 1234, true, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("baseEntityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("widthCounts").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("lineageDepth").ToString()); +Console.WriteLine(result.GetProperty("lineageWidth").ToString()); +Console.WriteLine(result.GetProperty("includeParent").ToString()); +Console.WriteLine(result.GetProperty("childrenCount").ToString()); +Console.WriteLine(result.GetProperty("lineageDirection").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("childEntityId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("parentEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("fromEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("toEntityId").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasLineageInfo: +{ + baseEntityGuid: string, # Optional. The GUID of the base entity. + guidEntityMap: Dictionary<string, AtlasEntityHeader>, # Optional. The GUID entity map. + widthCounts: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The entity count in specific direction. + lineageDepth: number, # Optional. The depth of lineage. + lineageWidth: number, # Optional. The width of lineage. + includeParent: boolean, # Optional. True to return the parent of the base entity. + childrenCount: number, # Optional. The number of children node. + lineageDirection: "INPUT" | "OUTPUT" | "BOTH", # Optional. The enum of lineage direction. + parentRelations: [ + { + childEntityId: string, # Optional. The GUID of child entity. + relationshipId: string, # Optional. The GUID of relationship. + parentEntityId: string, # Optional. The GUID of parent entity. + } + ], # Optional. An array of parentRelations relations. + relations: [ + { + fromEntityId: string, # Optional. The GUID of from-entity. + relationshipId: string, # Optional. The GUID of relationship. + toEntityId: string, # Optional. The GUID of to-entity. + } + ], # Optional. An array of lineage relations. +} + + + + + + +This sample shows how to call NextPageLineageAsync with required parameters and parse the result. +", credential); + +Response response = await client.NextPageLineageAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call NextPageLineageAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.NextPageLineageAsync("", "", true, 1234, 1234); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("baseEntityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("widthCounts").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("lineageDepth").ToString()); +Console.WriteLine(result.GetProperty("lineageWidth").ToString()); +Console.WriteLine(result.GetProperty("includeParent").ToString()); +Console.WriteLine(result.GetProperty("childrenCount").ToString()); +Console.WriteLine(result.GetProperty("lineageDirection").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("childEntityId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("parentEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("fromEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("toEntityId").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasLineageInfo: +{ + baseEntityGuid: string, # Optional. The GUID of the base entity. + guidEntityMap: Dictionary<string, AtlasEntityHeader>, # Optional. The GUID entity map. + widthCounts: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The entity count in specific direction. + lineageDepth: number, # Optional. The depth of lineage. + lineageWidth: number, # Optional. The width of lineage. + includeParent: boolean, # Optional. True to return the parent of the base entity. + childrenCount: number, # Optional. The number of children node. + lineageDirection: "INPUT" | "OUTPUT" | "BOTH", # Optional. The enum of lineage direction. + parentRelations: [ + { + childEntityId: string, # Optional. The GUID of child entity. + relationshipId: string, # Optional. The GUID of relationship. + parentEntityId: string, # Optional. The GUID of parent entity. + } + ], # Optional. An array of parentRelations relations. + relations: [ + { + fromEntityId: string, # Optional. The GUID of from-entity. + relationshipId: string, # Optional. The GUID of relationship. + toEntityId: string, # Optional. The GUID of to-entity. + } + ], # Optional. An array of lineage relations. +} + + + + + + +This sample shows how to call NextPageLineage with required parameters and parse the result. +", credential); + +Response response = client.NextPageLineage("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call NextPageLineage with all parameters, and how to parse the result. +", credential); + +Response response = client.NextPageLineage("", "", true, 1234, 1234); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("baseEntityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("widthCounts").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("lineageDepth").ToString()); +Console.WriteLine(result.GetProperty("lineageWidth").ToString()); +Console.WriteLine(result.GetProperty("includeParent").ToString()); +Console.WriteLine(result.GetProperty("childrenCount").ToString()); +Console.WriteLine(result.GetProperty("lineageDirection").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("childEntityId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("parentEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("fromEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("toEntityId").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasLineageInfo: +{ + baseEntityGuid: string, # Optional. The GUID of the base entity. + guidEntityMap: Dictionary<string, AtlasEntityHeader>, # Optional. The GUID entity map. + widthCounts: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The entity count in specific direction. + lineageDepth: number, # Optional. The depth of lineage. + lineageWidth: number, # Optional. The width of lineage. + includeParent: boolean, # Optional. True to return the parent of the base entity. + childrenCount: number, # Optional. The number of children node. + lineageDirection: "INPUT" | "OUTPUT" | "BOTH", # Optional. The enum of lineage direction. + parentRelations: [ + { + childEntityId: string, # Optional. The GUID of child entity. + relationshipId: string, # Optional. The GUID of relationship. + parentEntityId: string, # Optional. The GUID of parent entity. + } + ], # Optional. An array of parentRelations relations. + relations: [ + { + fromEntityId: string, # Optional. The GUID of from-entity. + relationshipId: string, # Optional. The GUID of relationship. + toEntityId: string, # Optional. The GUID of to-entity. + } + ], # Optional. An array of lineage relations. +} + + + + + + +This sample shows how to call GetLineageByUniqueAttributeAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetLineageByUniqueAttributeAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetLineageByUniqueAttributeAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetLineageByUniqueAttributeAsync("", "", 1234, 1234, true, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("baseEntityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("widthCounts").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("lineageDepth").ToString()); +Console.WriteLine(result.GetProperty("lineageWidth").ToString()); +Console.WriteLine(result.GetProperty("includeParent").ToString()); +Console.WriteLine(result.GetProperty("childrenCount").ToString()); +Console.WriteLine(result.GetProperty("lineageDirection").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("childEntityId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("parentEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("fromEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("toEntityId").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasLineageInfo: +{ + baseEntityGuid: string, # Optional. The GUID of the base entity. + guidEntityMap: Dictionary<string, AtlasEntityHeader>, # Optional. The GUID entity map. + widthCounts: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The entity count in specific direction. + lineageDepth: number, # Optional. The depth of lineage. + lineageWidth: number, # Optional. The width of lineage. + includeParent: boolean, # Optional. True to return the parent of the base entity. + childrenCount: number, # Optional. The number of children node. + lineageDirection: "INPUT" | "OUTPUT" | "BOTH", # Optional. The enum of lineage direction. + parentRelations: [ + { + childEntityId: string, # Optional. The GUID of child entity. + relationshipId: string, # Optional. The GUID of relationship. + parentEntityId: string, # Optional. The GUID of parent entity. + } + ], # Optional. An array of parentRelations relations. + relations: [ + { + fromEntityId: string, # Optional. The GUID of from-entity. + relationshipId: string, # Optional. The GUID of relationship. + toEntityId: string, # Optional. The GUID of to-entity. + } + ], # Optional. An array of lineage relations. +} + + + + + + +This sample shows how to call GetLineageByUniqueAttribute with required parameters and parse the result. +", credential); + +Response response = client.GetLineageByUniqueAttribute("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetLineageByUniqueAttribute with all parameters, and how to parse the result. +", credential); + +Response response = client.GetLineageByUniqueAttribute("", "", 1234, 1234, true, true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("baseEntityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("widthCounts").GetProperty("").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("lineageDepth").ToString()); +Console.WriteLine(result.GetProperty("lineageWidth").ToString()); +Console.WriteLine(result.GetProperty("includeParent").ToString()); +Console.WriteLine(result.GetProperty("childrenCount").ToString()); +Console.WriteLine(result.GetProperty("lineageDirection").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("childEntityId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("parentEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("fromEntityId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("relationshipId").ToString()); +Console.WriteLine(result.GetProperty("relations")[0].GetProperty("toEntityId").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasLineageInfo: +{ + baseEntityGuid: string, # Optional. The GUID of the base entity. + guidEntityMap: Dictionary<string, AtlasEntityHeader>, # Optional. The GUID entity map. + widthCounts: Dictionary<string, Dictionary<string, AnyObject>>, # Optional. The entity count in specific direction. + lineageDepth: number, # Optional. The depth of lineage. + lineageWidth: number, # Optional. The width of lineage. + includeParent: boolean, # Optional. True to return the parent of the base entity. + childrenCount: number, # Optional. The number of children node. + lineageDirection: "INPUT" | "OUTPUT" | "BOTH", # Optional. The enum of lineage direction. + parentRelations: [ + { + childEntityId: string, # Optional. The GUID of child entity. + relationshipId: string, # Optional. The GUID of relationship. + parentEntityId: string, # Optional. The GUID of parent entity. + } + ], # Optional. An array of parentRelations relations. + relations: [ + { + fromEntityId: string, # Optional. The GUID of from-entity. + relationshipId: string, # Optional. The GUID of relationship. + toEntityId: string, # Optional. The GUID of to-entity. + } + ], # Optional. An array of lineage relations. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/MetadataPolicyClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/MetadataPolicyClient.xml new file mode 100644 index 000000000000..d08451e491e8 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/MetadataPolicyClient.xml @@ -0,0 +1,639 @@ + + + + + +This sample shows how to call UpdateAsync with required parameters and parse the result. +", "", credential); + +var data = new {}; + +Response response = await client.UpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateAsync with all parameters and request content, and how to parse the result. +", "", credential); + +var data = new { + name = "", + id = "", + version = 1234, + properties = new { + description = "", + decisionRules = new[] { + new { + effect = "Deny", + dnfCondition = new[] { + new[] { + new { + attributeName = "", + attributeValueIncludes = "", + attributeValueIncludedIn = new[] { + "" + }, + attributeValueExcludes = "", + attributeValueExcludedIn = new[] { + "" + }, + } + } + }, + } + }, + attributeRules = new[] { + new { + id = "", + name = "", + dnfCondition = new[] { + new[] { + new { + attributeName = "", + attributeValueIncludes = "", + attributeValueIncludedIn = new[] { + "" + }, + attributeValueExcludes = "", + attributeValueExcludedIn = new[] { + "" + }, + } + } + }, + } + }, + collection = new { + type = "", + referenceName = "", + }, + parentCollectionName = "", + }, +}; + +Response response = await client.UpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("effect").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("referenceName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("parentCollectionName").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for MetadataPolicy: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + +Response Body: + +Schema for MetadataPolicy: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + + + + + +This sample shows how to call Update with required parameters and parse the result. +", "", credential); + +var data = new {}; + +Response response = client.Update("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Update with all parameters and request content, and how to parse the result. +", "", credential); + +var data = new { + name = "", + id = "", + version = 1234, + properties = new { + description = "", + decisionRules = new[] { + new { + effect = "Deny", + dnfCondition = new[] { + new[] { + new { + attributeName = "", + attributeValueIncludes = "", + attributeValueIncludedIn = new[] { + "" + }, + attributeValueExcludes = "", + attributeValueExcludedIn = new[] { + "" + }, + } + } + }, + } + }, + attributeRules = new[] { + new { + id = "", + name = "", + dnfCondition = new[] { + new[] { + new { + attributeName = "", + attributeValueIncludes = "", + attributeValueIncludedIn = new[] { + "" + }, + attributeValueExcludes = "", + attributeValueExcludedIn = new[] { + "" + }, + } + } + }, + } + }, + collection = new { + type = "", + referenceName = "", + }, + parentCollectionName = "", + }, +}; + +Response response = client.Update("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("effect").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("referenceName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("parentCollectionName").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for MetadataPolicy: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + +Response Body: + +Schema for MetadataPolicy: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + + + + + +This sample shows how to call GetMetadataPolicyAsync with required parameters and parse the result. +", "", credential); + +Response response = await client.GetMetadataPolicyAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("effect").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("referenceName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("parentCollectionName").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for MetadataPolicy: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + + + + + +This sample shows how to call GetMetadataPolicy with required parameters and parse the result. +", "", credential); + +Response response = client.GetMetadataPolicy(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("effect").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("referenceName").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("parentCollectionName").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for MetadataPolicy: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + + + + + +This sample shows how to call GetMetadataPoliciesAsync and parse the result. +", "", credential); + +await foreach (var data in client.GetMetadataPoliciesAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("effect").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("referenceName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("parentCollectionName").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for MetadataPolicyListValues: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + + + + + +This sample shows how to call GetMetadataPolicies and parse the result. +", "", credential); + +foreach (var data in client.GetMetadataPolicies()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("effect").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("decisionRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("attributeRules")[0].GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("collection").GetProperty("referenceName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("parentCollectionName").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for MetadataPolicyListValues: +{ + name: string, # Optional. The name of policy + id: string, # Optional. The id of policy + version: number, # Optional. The version of policy + properties: { + description: string, # Optional. The description of policy + decisionRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + effect: "Deny" | "Permit", # Optional. The effect for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The DecisionRules of policy + attributeRules: [ + { + kind: "decisionrule" | "attributerule", # Optional. The kind of rule + id: string, # Optional. The id for rule + name: string, # Optional. The name for rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + } + ], # Optional. The AttributeRules of policy + collection: { + type: string, # Optional. The type of reference + referenceName: string, # Optional. The name of reference + }, # Optional. The collection reference for a policy + parentCollectionName: string, # Optional. The parent collection of the policy + }, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/MetadataRolesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/MetadataRolesClient.xml new file mode 100644 index 000000000000..b5861afe1b59 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/MetadataRolesClient.xml @@ -0,0 +1,115 @@ + + + + + +This sample shows how to call GetMetadataRolesAsync and parse the result. +", credential); + +await foreach (var data in client.GetMetadataRolesAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("provisioningState").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("roleType").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("friendlyName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("version").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for MetadataRoleListValues: +{ + id: string, # Optional. The Id of role + name: string, # Optional. The name of role + type: string, # Optional. The type of role + properties: { + provisioningState: string, # Optional. The provisioningState of role + roleType: string, # Optional. The type of role + friendlyName: string, # Optional. The friendly name of role + description: string, # Optional. The description of role + cnfCondition: [AttributeMatcher[]], # Optional. The cnf Condition for a rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + version: number, # Optional. The version of role + }, # Optional. +} + + + + + + +This sample shows how to call GetMetadataRoles and parse the result. +", credential); + +foreach (var data in client.GetMetadataRoles()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("provisioningState").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("roleType").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("friendlyName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("description").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("cnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeName").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueIncludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludes").ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("dnfCondition")[0][0].GetProperty("attributeValueExcludedIn")[0].ToString()); + Console.WriteLine(result.GetProperty("properties").GetProperty("version").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for MetadataRoleListValues: +{ + id: string, # Optional. The Id of role + name: string, # Optional. The name of role + type: string, # Optional. The type of role + properties: { + provisioningState: string, # Optional. The provisioningState of role + roleType: string, # Optional. The type of role + friendlyName: string, # Optional. The friendly name of role + description: string, # Optional. The description of role + cnfCondition: [AttributeMatcher[]], # Optional. The cnf Condition for a rule + dnfCondition: [AttributeMatcher[]], # Optional. The dnf Condition for a rule + version: number, # Optional. The version of role + }, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PolicyElementsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PolicyElementsClient.xml new file mode 100644 index 000000000000..0f946a6825c0 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PolicyElementsClient.xml @@ -0,0 +1,105 @@ + + + + + +This sample shows how to call GetPolicyElementsAsync with required parameters and parse the result. +"); +var client = new PolicyElementsClient(endpoint, credential); + +await foreach (var data in client.GetPolicyElementsAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetPolicyElementsAsync with all parameters, and how to parse the result. +"); +var client = new PolicyElementsClient(endpoint, credential); + +await foreach (var data in client.GetPolicyElementsAsync("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scopes")[0].ToString()); + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("updatedAt").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("elementJson").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for PolicyResponseElements: +{ + id: string, # Optional. Id of the policy element. + scopes: [string], # Optional. List of scopes included in this policy. + kind: string, # Optional. Kind of policy element. Possible values: policy/policySet/attributeRule. + updatedAt: string, # Optional. Time at which this policy element is last updated. + version: number, # Optional. Current version of policy element. This is auto incremented with each change. Starts with 1. + elementJson: string, # Optional. Policy element serialized json payload. +} + + + + + + +This sample shows how to call GetPolicyElements with required parameters and parse the result. +"); +var client = new PolicyElementsClient(endpoint, credential); + +foreach (var data in client.GetPolicyElements("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetPolicyElements with all parameters, and how to parse the result. +"); +var client = new PolicyElementsClient(endpoint, credential); + +foreach (var data in client.GetPolicyElements("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scopes")[0].ToString()); + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("updatedAt").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("elementJson").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for PolicyResponseElements: +{ + id: string, # Optional. Id of the policy element. + scopes: [string], # Optional. List of scopes included in this policy. + kind: string, # Optional. Kind of policy element. Possible values: policy/policySet/attributeRule. + updatedAt: string, # Optional. Time at which this policy element is last updated. + version: number, # Optional. Current version of policy element. This is auto incremented with each change. Starts with 1. + elementJson: string, # Optional. Policy element serialized json payload. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PolicyEventsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PolicyEventsClient.xml new file mode 100644 index 000000000000..0336dffd5e13 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PolicyEventsClient.xml @@ -0,0 +1,99 @@ + + + + + +This sample shows how to call GetPolicyEventsAsync with required parameters and parse the result. +"); +var client = new PolicyEventsClient(endpoint, credential); + +Response response = await client.GetPolicyEventsAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("syncToken").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("scopes")[0].ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("updatedAt").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("elementJson").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("eventType").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for PolicyEventsResponse: +{ + count: number, # Optional. Count of elements in payload. + syncToken: string, # Optional. Sync token represents the checkpoint upto which this policy elements list is updated. Client need to store this value and keep updating if PDS returns a new value. Call this API with the most recent value received. + elements: [ + { + id: string, # Optional. Id of the policy element. + scopes: [string], # Optional. List of scopes included in this policy. + kind: string, # Optional. Kind of policy element. Possible values: policy/policySet/attributeRule. + updatedAt: string, # Optional. Time at which this policy element is last updated. + version: number, # Optional. Current version of policy element. This is auto incremented with each change. Starts with 1. + elementJson: string, # Optional. Policy element serialized json payload. + eventType: string, # Optional. Type of event. Format: <RP-Name>/<Resource-Type>/<Action>. For Example: Microsoft.Purview/PolicyElements/Delete. + } + ], # Optional. List of created/updated policy elements. +} + + + + + + +This sample shows how to call GetPolicyEvents with required parameters and parse the result. +"); +var client = new PolicyEventsClient(endpoint, credential); + +Response response = client.GetPolicyEvents("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("count").ToString()); +Console.WriteLine(result.GetProperty("syncToken").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("scopes")[0].ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("updatedAt").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("elementJson").ToString()); +Console.WriteLine(result.GetProperty("elements")[0].GetProperty("eventType").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for PolicyEventsResponse: +{ + count: number, # Optional. Count of elements in payload. + syncToken: string, # Optional. Sync token represents the checkpoint upto which this policy elements list is updated. Client need to store this value and keep updating if PDS returns a new value. Call this API with the most recent value received. + elements: [ + { + id: string, # Optional. Id of the policy element. + scopes: [string], # Optional. List of scopes included in this policy. + kind: string, # Optional. Kind of policy element. Possible values: policy/policySet/attributeRule. + updatedAt: string, # Optional. Time at which this policy element is last updated. + version: number, # Optional. Current version of policy element. This is auto incremented with each change. Starts with 1. + elementJson: string, # Optional. Policy element serialized json payload. + eventType: string, # Optional. Type of event. Format: <RP-Name>/<Resource-Type>/<Action>. For Example: Microsoft.Purview/PolicyElements/Delete. + } + ], # Optional. List of created/updated policy elements. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewAccountClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewAccountClient.xml deleted file mode 100644 index d33d4e3dab15..000000000000 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewAccountClient.xml +++ /dev/null @@ -1,1287 +0,0 @@ - - - - - -This sample shows how to call GetAccountPropertiesAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -Response response = await client.GetAccountPropertiesAsync(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("principalId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("tenantId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("location").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("cloudConnectors").GetProperty("awsExternalId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdByObjectId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("catalog").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("guardian").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("scan").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResourceGroupName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("eventHubNamespace").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("resourceGroup").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("storageAccount").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateEndpoint").GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("actionsRequired").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("status").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("publicNetworkAccess").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("capacity").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -Console.WriteLine(result.GetProperty("tags").GetProperty("").ToString()); -Console.WriteLine(result.GetProperty("type").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for Account: -{ - id: string, # Optional. Gets or sets the identifier. - identity: { - principalId: string, # Optional. Service principal object Id - tenantId: string, # Optional. Tenant Id - type: "SystemAssigned", # Optional. Identity Type - }, # Optional. Identity Info on the tracked resource - location: string, # Optional. Gets or sets the location. - name: string, # Optional. Gets or sets the name. - properties: { - cloudConnectors: { - awsExternalId: string, # Optional. AWS external identifier. -Configured in AWS to allow use of the role arn used for scanning - }, # Optional. Cloud connectors. -External cloud identifier used as part of scanning configuration. - createdAt: string (ISO 8601 Format), # Optional. Gets the time at which the entity was created. - createdBy: string, # Optional. Gets the creator of the entity. - createdByObjectId: string, # Optional. Gets the creators of the entity's object id. - endpoints: { - catalog: string, # Optional. Gets the catalog endpoint. - guardian: string, # Optional. Gets the guardian endpoint. - scan: string, # Optional. Gets the scan endpoint. - }, # Optional. The URIs that are the public endpoints of the account. - friendlyName: string, # Optional. Gets or sets the friendly name. - managedResourceGroupName: string, # Optional. Gets or sets the managed resource group name - managedResources: { - eventHubNamespace: string, # Optional. Gets the managed event hub namespace resource identifier. - resourceGroup: string, # Optional. Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. - storageAccount: string, # Optional. Gets the managed storage account resource identifier. - }, # Optional. Gets the resource identifiers of the managed resources. - privateEndpointConnections: [ - { - id: string, # Optional. Gets or sets the identifier. - name: string, # Optional. Gets or sets the name. - properties: { - privateEndpoint: { - id: string, # Optional. The private endpoint identifier. - }, # Optional. The private endpoint information. - privateLinkServiceConnectionState: { - actionsRequired: string, # Optional. The required actions. - description: string, # Optional. The description. - status: "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected", # Optional. The status. - }, # Optional. The private link service connection state. - provisioningState: string, # Optional. The provisioning state. - }, # Optional. The connection identifier. - type: string, # Optional. Gets or sets the type. - } - ], # Optional. Gets the private endpoint connections information. - provisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "SoftDeleting" | "SoftDeleted" | "Failed" | "Succeeded" | "Canceled", # Optional. Gets or sets the state of the provisioning. - publicNetworkAccess: "NotSpecified" | "Enabled" | "Disabled", # Optional. Gets or sets the public network access. - }, # Optional. Gets or sets the properties. - sku: { - capacity: number, # Optional. Gets or sets the sku capacity. Possible values include: 4, 16 - name: "Standard", # Optional. Gets or sets the sku name. - }, # Optional. Gets or sets the Sku. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Metadata pertaining to creation and last modification of the resource. - tags: Dictionary<string, string>, # Optional. Tags on the azure resource. - type: string, # Optional. Gets or sets the type. -} - - - - - - -This sample shows how to call GetAccountProperties and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -Response response = client.GetAccountProperties(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("principalId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("tenantId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("location").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("cloudConnectors").GetProperty("awsExternalId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdByObjectId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("catalog").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("guardian").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("scan").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResourceGroupName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("eventHubNamespace").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("resourceGroup").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("storageAccount").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateEndpoint").GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("actionsRequired").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("status").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("publicNetworkAccess").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("capacity").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -Console.WriteLine(result.GetProperty("tags").GetProperty("").ToString()); -Console.WriteLine(result.GetProperty("type").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for Account: -{ - id: string, # Optional. Gets or sets the identifier. - identity: { - principalId: string, # Optional. Service principal object Id - tenantId: string, # Optional. Tenant Id - type: "SystemAssigned", # Optional. Identity Type - }, # Optional. Identity Info on the tracked resource - location: string, # Optional. Gets or sets the location. - name: string, # Optional. Gets or sets the name. - properties: { - cloudConnectors: { - awsExternalId: string, # Optional. AWS external identifier. -Configured in AWS to allow use of the role arn used for scanning - }, # Optional. Cloud connectors. -External cloud identifier used as part of scanning configuration. - createdAt: string (ISO 8601 Format), # Optional. Gets the time at which the entity was created. - createdBy: string, # Optional. Gets the creator of the entity. - createdByObjectId: string, # Optional. Gets the creators of the entity's object id. - endpoints: { - catalog: string, # Optional. Gets the catalog endpoint. - guardian: string, # Optional. Gets the guardian endpoint. - scan: string, # Optional. Gets the scan endpoint. - }, # Optional. The URIs that are the public endpoints of the account. - friendlyName: string, # Optional. Gets or sets the friendly name. - managedResourceGroupName: string, # Optional. Gets or sets the managed resource group name - managedResources: { - eventHubNamespace: string, # Optional. Gets the managed event hub namespace resource identifier. - resourceGroup: string, # Optional. Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. - storageAccount: string, # Optional. Gets the managed storage account resource identifier. - }, # Optional. Gets the resource identifiers of the managed resources. - privateEndpointConnections: [ - { - id: string, # Optional. Gets or sets the identifier. - name: string, # Optional. Gets or sets the name. - properties: { - privateEndpoint: { - id: string, # Optional. The private endpoint identifier. - }, # Optional. The private endpoint information. - privateLinkServiceConnectionState: { - actionsRequired: string, # Optional. The required actions. - description: string, # Optional. The description. - status: "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected", # Optional. The status. - }, # Optional. The private link service connection state. - provisioningState: string, # Optional. The provisioning state. - }, # Optional. The connection identifier. - type: string, # Optional. Gets or sets the type. - } - ], # Optional. Gets the private endpoint connections information. - provisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "SoftDeleting" | "SoftDeleted" | "Failed" | "Succeeded" | "Canceled", # Optional. Gets or sets the state of the provisioning. - publicNetworkAccess: "NotSpecified" | "Enabled" | "Disabled", # Optional. Gets or sets the public network access. - }, # Optional. Gets or sets the properties. - sku: { - capacity: number, # Optional. Gets or sets the sku capacity. Possible values include: 4, 16 - name: "Standard", # Optional. Gets or sets the sku name. - }, # Optional. Gets or sets the Sku. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Metadata pertaining to creation and last modification of the resource. - tags: Dictionary<string, string>, # Optional. Tags on the azure resource. - type: string, # Optional. Gets or sets the type. -} - - - - - - -This sample shows how to call UpdateAccountPropertiesAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new {}; - -Response response = await client.UpdateAccountPropertiesAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call UpdateAccountPropertiesAsync with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new { - friendlyName = "", -}; - -Response response = await client.UpdateAccountPropertiesAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("principalId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("tenantId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("location").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("cloudConnectors").GetProperty("awsExternalId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdByObjectId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("catalog").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("guardian").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("scan").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResourceGroupName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("eventHubNamespace").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("resourceGroup").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("storageAccount").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateEndpoint").GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("actionsRequired").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("status").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("publicNetworkAccess").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("capacity").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -Console.WriteLine(result.GetProperty("tags").GetProperty("").ToString()); -Console.WriteLine(result.GetProperty("type").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for DataPlaneAccountUpdateParameters: -{ - friendlyName: string, # Optional. The friendly name for the azure resource. -} - - -Response Body: - -Schema for Account: -{ - id: string, # Optional. Gets or sets the identifier. - identity: { - principalId: string, # Optional. Service principal object Id - tenantId: string, # Optional. Tenant Id - type: "SystemAssigned", # Optional. Identity Type - }, # Optional. Identity Info on the tracked resource - location: string, # Optional. Gets or sets the location. - name: string, # Optional. Gets or sets the name. - properties: { - cloudConnectors: { - awsExternalId: string, # Optional. AWS external identifier. -Configured in AWS to allow use of the role arn used for scanning - }, # Optional. Cloud connectors. -External cloud identifier used as part of scanning configuration. - createdAt: string (ISO 8601 Format), # Optional. Gets the time at which the entity was created. - createdBy: string, # Optional. Gets the creator of the entity. - createdByObjectId: string, # Optional. Gets the creators of the entity's object id. - endpoints: { - catalog: string, # Optional. Gets the catalog endpoint. - guardian: string, # Optional. Gets the guardian endpoint. - scan: string, # Optional. Gets the scan endpoint. - }, # Optional. The URIs that are the public endpoints of the account. - friendlyName: string, # Optional. Gets or sets the friendly name. - managedResourceGroupName: string, # Optional. Gets or sets the managed resource group name - managedResources: { - eventHubNamespace: string, # Optional. Gets the managed event hub namespace resource identifier. - resourceGroup: string, # Optional. Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. - storageAccount: string, # Optional. Gets the managed storage account resource identifier. - }, # Optional. Gets the resource identifiers of the managed resources. - privateEndpointConnections: [ - { - id: string, # Optional. Gets or sets the identifier. - name: string, # Optional. Gets or sets the name. - properties: { - privateEndpoint: { - id: string, # Optional. The private endpoint identifier. - }, # Optional. The private endpoint information. - privateLinkServiceConnectionState: { - actionsRequired: string, # Optional. The required actions. - description: string, # Optional. The description. - status: "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected", # Optional. The status. - }, # Optional. The private link service connection state. - provisioningState: string, # Optional. The provisioning state. - }, # Optional. The connection identifier. - type: string, # Optional. Gets or sets the type. - } - ], # Optional. Gets the private endpoint connections information. - provisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "SoftDeleting" | "SoftDeleted" | "Failed" | "Succeeded" | "Canceled", # Optional. Gets or sets the state of the provisioning. - publicNetworkAccess: "NotSpecified" | "Enabled" | "Disabled", # Optional. Gets or sets the public network access. - }, # Optional. Gets or sets the properties. - sku: { - capacity: number, # Optional. Gets or sets the sku capacity. Possible values include: 4, 16 - name: "Standard", # Optional. Gets or sets the sku name. - }, # Optional. Gets or sets the Sku. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Metadata pertaining to creation and last modification of the resource. - tags: Dictionary<string, string>, # Optional. Tags on the azure resource. - type: string, # Optional. Gets or sets the type. -} - - - - - - -This sample shows how to call UpdateAccountProperties and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new {}; - -Response response = client.UpdateAccountProperties(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call UpdateAccountProperties with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new { - friendlyName = "", -}; - -Response response = client.UpdateAccountProperties(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("principalId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("tenantId").ToString()); -Console.WriteLine(result.GetProperty("identity").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("location").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("cloudConnectors").GetProperty("awsExternalId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("createdByObjectId").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("catalog").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("guardian").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("endpoints").GetProperty("scan").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResourceGroupName").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("eventHubNamespace").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("resourceGroup").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("managedResources").GetProperty("storageAccount").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateEndpoint").GetProperty("id").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("actionsRequired").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("privateLinkServiceConnectionState").GetProperty("status").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("privateEndpointConnections")[0].GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("provisioningState").ToString()); -Console.WriteLine(result.GetProperty("properties").GetProperty("publicNetworkAccess").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("capacity").ToString()); -Console.WriteLine(result.GetProperty("sku").GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -Console.WriteLine(result.GetProperty("tags").GetProperty("").ToString()); -Console.WriteLine(result.GetProperty("type").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for DataPlaneAccountUpdateParameters: -{ - friendlyName: string, # Optional. The friendly name for the azure resource. -} - - -Response Body: - -Schema for Account: -{ - id: string, # Optional. Gets or sets the identifier. - identity: { - principalId: string, # Optional. Service principal object Id - tenantId: string, # Optional. Tenant Id - type: "SystemAssigned", # Optional. Identity Type - }, # Optional. Identity Info on the tracked resource - location: string, # Optional. Gets or sets the location. - name: string, # Optional. Gets or sets the name. - properties: { - cloudConnectors: { - awsExternalId: string, # Optional. AWS external identifier. -Configured in AWS to allow use of the role arn used for scanning - }, # Optional. Cloud connectors. -External cloud identifier used as part of scanning configuration. - createdAt: string (ISO 8601 Format), # Optional. Gets the time at which the entity was created. - createdBy: string, # Optional. Gets the creator of the entity. - createdByObjectId: string, # Optional. Gets the creators of the entity's object id. - endpoints: { - catalog: string, # Optional. Gets the catalog endpoint. - guardian: string, # Optional. Gets the guardian endpoint. - scan: string, # Optional. Gets the scan endpoint. - }, # Optional. The URIs that are the public endpoints of the account. - friendlyName: string, # Optional. Gets or sets the friendly name. - managedResourceGroupName: string, # Optional. Gets or sets the managed resource group name - managedResources: { - eventHubNamespace: string, # Optional. Gets the managed event hub namespace resource identifier. - resourceGroup: string, # Optional. Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. - storageAccount: string, # Optional. Gets the managed storage account resource identifier. - }, # Optional. Gets the resource identifiers of the managed resources. - privateEndpointConnections: [ - { - id: string, # Optional. Gets or sets the identifier. - name: string, # Optional. Gets or sets the name. - properties: { - privateEndpoint: { - id: string, # Optional. The private endpoint identifier. - }, # Optional. The private endpoint information. - privateLinkServiceConnectionState: { - actionsRequired: string, # Optional. The required actions. - description: string, # Optional. The description. - status: "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected", # Optional. The status. - }, # Optional. The private link service connection state. - provisioningState: string, # Optional. The provisioning state. - }, # Optional. The connection identifier. - type: string, # Optional. Gets or sets the type. - } - ], # Optional. Gets the private endpoint connections information. - provisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "SoftDeleting" | "SoftDeleted" | "Failed" | "Succeeded" | "Canceled", # Optional. Gets or sets the state of the provisioning. - publicNetworkAccess: "NotSpecified" | "Enabled" | "Disabled", # Optional. Gets or sets the public network access. - }, # Optional. Gets or sets the properties. - sku: { - capacity: number, # Optional. Gets or sets the sku capacity. Possible values include: 4, 16 - name: "Standard", # Optional. Gets or sets the sku name. - }, # Optional. Gets or sets the Sku. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Metadata pertaining to creation and last modification of the resource. - tags: Dictionary<string, string>, # Optional. Tags on the azure resource. - type: string, # Optional. Gets or sets the type. -} - - - - - - -This sample shows how to call GetAccessKeysAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -Response response = await client.GetAccessKeysAsync(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("atlasKafkaPrimaryEndpoint").ToString()); -Console.WriteLine(result.GetProperty("atlasKafkaSecondaryEndpoint").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for AccessKeys: -{ - atlasKafkaPrimaryEndpoint: string, # Optional. Gets or sets the primary connection string. - atlasKafkaSecondaryEndpoint: string, # Optional. Gets or sets the secondary connection string. -} - - - - - - -This sample shows how to call GetAccessKeys and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -Response response = client.GetAccessKeys(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("atlasKafkaPrimaryEndpoint").ToString()); -Console.WriteLine(result.GetProperty("atlasKafkaSecondaryEndpoint").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for AccessKeys: -{ - atlasKafkaPrimaryEndpoint: string, # Optional. Gets or sets the primary connection string. - atlasKafkaSecondaryEndpoint: string, # Optional. Gets or sets the secondary connection string. -} - - - - - - -This sample shows how to call RegenerateAccessKeyAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new {}; - -Response response = await client.RegenerateAccessKeyAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call RegenerateAccessKeyAsync with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new { - keyType = "PrimaryAtlasKafkaKey", -}; - -Response response = await client.RegenerateAccessKeyAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("atlasKafkaPrimaryEndpoint").ToString()); -Console.WriteLine(result.GetProperty("atlasKafkaSecondaryEndpoint").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for AccessKeyOptions: -{ - keyType: "PrimaryAtlasKafkaKey" | "SecondaryAtlasKafkaKey", # Optional. The access key type. -} - - -Response Body: - -Schema for AccessKeys: -{ - atlasKafkaPrimaryEndpoint: string, # Optional. Gets or sets the primary connection string. - atlasKafkaSecondaryEndpoint: string, # Optional. Gets or sets the secondary connection string. -} - - - - - - -This sample shows how to call RegenerateAccessKey and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new {}; - -Response response = client.RegenerateAccessKey(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call RegenerateAccessKey with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -var data = new { - keyType = "PrimaryAtlasKafkaKey", -}; - -Response response = client.RegenerateAccessKey(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("atlasKafkaPrimaryEndpoint").ToString()); -Console.WriteLine(result.GetProperty("atlasKafkaSecondaryEndpoint").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for AccessKeyOptions: -{ - keyType: "PrimaryAtlasKafkaKey" | "SecondaryAtlasKafkaKey", # Optional. The access key type. -} - - -Response Body: - -Schema for AccessKeys: -{ - atlasKafkaPrimaryEndpoint: string, # Optional. Gets or sets the primary connection string. - atlasKafkaSecondaryEndpoint: string, # Optional. Gets or sets the secondary connection string. -} - - - - - - -This sample shows how to call GetCollectionsAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -await foreach (var data in client.GetCollectionsAsync()) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.ToString()); -} -]]> -This sample shows how to call GetCollectionsAsync with all parameters, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -await foreach (var data in client.GetCollectionsAsync("")) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.GetProperty("collectionProvisioningState").ToString()); - Console.WriteLine(result.GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("friendlyName").ToString()); - Console.WriteLine(result.GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("parentCollection").GetProperty("referenceName").ToString()); - Console.WriteLine(result.GetProperty("parentCollection").GetProperty("type").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -} -]]> - - -Below is the JSON schema for one item in the pageable response. - -Response Body: - -Schema for CollectionListValue: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - - - - - -This sample shows how to call GetCollections and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -foreach (var data in client.GetCollections()) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.ToString()); -} -]]> -This sample shows how to call GetCollections with all parameters, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -foreach (var data in client.GetCollections("")) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.GetProperty("collectionProvisioningState").ToString()); - Console.WriteLine(result.GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("friendlyName").ToString()); - Console.WriteLine(result.GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("parentCollection").GetProperty("referenceName").ToString()); - Console.WriteLine(result.GetProperty("parentCollection").GetProperty("type").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); - Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -} -]]> - - -Below is the JSON schema for one item in the pageable response. - -Response Body: - -Schema for CollectionListValue: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - - - - - -This sample shows how to call GetResourceSetRulesAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -await foreach (var data in client.GetResourceSetRulesAsync()) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.ToString()); -} -]]> -This sample shows how to call GetResourceSetRulesAsync with all parameters, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -await foreach (var data in client.GetResourceSetRulesAsync("")) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("modifiedAt").ToString()); - Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("resourceSetProcessing").ToString()); - Console.WriteLine(result.GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("filterType").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("path").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disabled").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("typeName").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("enableDefaultPatterns").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("disabled").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("dynamicReplacement").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("entityTypes")[0].ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDashes").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDots").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minHex").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("options").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("regexStr").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("replaceWith").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("version").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("condition").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disabled").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDashes").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigitsOrLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDots").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minHex").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minUnderscores").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("options").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("regexStr").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDashes").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDots").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minHex").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("options").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("regexStr").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("replaceWith").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("filterType").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("path").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("bindingUrl").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("displayName").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("isResourceSet").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("qualifiedName").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("storeType").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("version").ToString()); -} -]]> - - -Below is the JSON schema for one item in the pageable response. - -Response Body: - -Schema for ResourceSetRuleConfigListValue: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - - - - - -This sample shows how to call GetResourceSetRules and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -foreach (var data in client.GetResourceSetRules()) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.ToString()); -} -]]> -This sample shows how to call GetResourceSetRules with all parameters, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential); - -foreach (var data in client.GetResourceSetRules("")) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("modifiedAt").ToString()); - Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("resourceSetProcessing").ToString()); - Console.WriteLine(result.GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("filterType").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("path").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disabled").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("typeName").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("enableDefaultPatterns").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("disabled").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("dynamicReplacement").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("entityTypes")[0].ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDashes").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDots").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minHex").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("options").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("regexStr").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("replaceWith").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("version").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("condition").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("description").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disabled").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDashes").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigitsOrLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDots").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minHex").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minUnderscores").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("options").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("regexStr").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDashes").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigits").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDots").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minHex").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minLetters").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("options").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("regexStr").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("replaceWith").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("createdBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("filterType").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("modifiedBy").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("path").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("bindingUrl").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("displayName").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("isResourceSet").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("lastUpdatedTimestamp").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("name").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("qualifiedName").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("storeType").ToString()); - Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("version").ToString()); -} -]]> - - -Below is the JSON schema for one item in the pageable response. - -Response Body: - -Schema for ResourceSetRuleConfigListValue: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - - - - - \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewCollection.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewCollection.xml deleted file mode 100644 index 070a94cfd9d5..000000000000 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewCollection.xml +++ /dev/null @@ -1,473 +0,0 @@ - - - - - -This sample shows how to call GetCollectionAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -Response response = await client.GetCollectionAsync(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("collectionProvisioningState").ToString()); -Console.WriteLine(result.GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("referenceName").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for Collection: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - - - - - -This sample shows how to call GetCollection and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -Response response = client.GetCollection(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("collectionProvisioningState").ToString()); -Console.WriteLine(result.GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("referenceName").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for Collection: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - - - - - -This sample shows how to call CreateOrUpdateCollectionAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -var data = new {}; - -Response response = await client.CreateOrUpdateCollectionAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call CreateOrUpdateCollectionAsync with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -var data = new { - description = "", - friendlyName = "", - parentCollection = new { - referenceName = "", - }, -}; - -Response response = await client.CreateOrUpdateCollectionAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("collectionProvisioningState").ToString()); -Console.WriteLine(result.GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("referenceName").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for Collection: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - -Response Body: - -Schema for Collection: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - - - - - -This sample shows how to call CreateOrUpdateCollection and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -var data = new {}; - -Response response = client.CreateOrUpdateCollection(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call CreateOrUpdateCollection with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -var data = new { - description = "", - friendlyName = "", - parentCollection = new { - referenceName = "", - }, -}; - -Response response = client.CreateOrUpdateCollection(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("collectionProvisioningState").ToString()); -Console.WriteLine(result.GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("friendlyName").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("referenceName").ToString()); -Console.WriteLine(result.GetProperty("parentCollection").GetProperty("type").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("createdByType").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedAt").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedBy").ToString()); -Console.WriteLine(result.GetProperty("systemData").GetProperty("lastModifiedByType").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for Collection: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - -Response Body: - -Schema for Collection: -{ - collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded", # Optional. Gets the state of the provisioning. - description: string, # Optional. Gets or sets the description. - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. - parentCollection: { - referenceName: string, # Optional. Gets or sets the reference name. - type: string, # Optional. Gets the reference type property. - }, # Optional. Gets or sets the parent collection reference. - systemData: { - createdAt: string (ISO 8601 Format), # Optional. The timestamp of resource creation (UTC). - createdBy: string, # Optional. The identity that created the resource. - createdByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that created the resource. - lastModifiedAt: string (ISO 8601 Format), # Optional. The timestamp of the last modification the resource (UTC). - lastModifiedBy: string, # Optional. The identity that last modified the resource. - lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key", # Optional. The type of identity that last modified the resource. - }, # Optional. Gets the system data that contains information about who and when created and updated the resource. -} - - - - - - -This sample shows how to call DeleteCollectionAsync. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -Response response = await client.DeleteCollectionAsync(); -Console.WriteLine(response.Status); -]]> - - - - -This sample shows how to call DeleteCollection. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -Response response = client.DeleteCollection(); -Console.WriteLine(response.Status); -]]> - - - - -This sample shows how to call GetCollectionPathAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -Response response = await client.GetCollectionPathAsync(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("parentFriendlyNameChain")[0].ToString()); -Console.WriteLine(result.GetProperty("parentNameChain")[0].ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for CollectionPathResponse: -{ - parentFriendlyNameChain: [string], # Optional. The friendly names of ancestors starting from the default (root) collection and ending with the immediate parent. - parentNameChain: [string], # Optional. The names of ancestors starting from the default (root) collection and ending with the immediate parent. -} - - - - - - -This sample shows how to call GetCollectionPath and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -Response response = client.GetCollectionPath(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("parentFriendlyNameChain")[0].ToString()); -Console.WriteLine(result.GetProperty("parentNameChain")[0].ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for CollectionPathResponse: -{ - parentFriendlyNameChain: [string], # Optional. The friendly names of ancestors starting from the default (root) collection and ending with the immediate parent. - parentNameChain: [string], # Optional. The names of ancestors starting from the default (root) collection and ending with the immediate parent. -} - - - - - - -This sample shows how to call GetChildCollectionNamesAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -await foreach (var data in client.GetChildCollectionNamesAsync()) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.ToString()); -} -]]> -This sample shows how to call GetChildCollectionNamesAsync with all parameters, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -await foreach (var data in client.GetChildCollectionNamesAsync("")) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.GetProperty("friendlyName").ToString()); - Console.WriteLine(result.GetProperty("name").ToString()); -} -]]> - - -Below is the JSON schema for one item in the pageable response. - -Response Body: - -Schema for CollectionNameResponseListValue: -{ - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. -} - - - - - - -This sample shows how to call GetChildCollectionNames and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -foreach (var data in client.GetChildCollectionNames()) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.ToString()); -} -]]> -This sample shows how to call GetChildCollectionNames with all parameters, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewCollectionClient(""); - -foreach (var data in client.GetChildCollectionNames("")) -{ - JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; - Console.WriteLine(result.GetProperty("friendlyName").ToString()); - Console.WriteLine(result.GetProperty("name").ToString()); -} -]]> - - -Below is the JSON schema for one item in the pageable response. - -Response Body: - -Schema for CollectionNameResponseListValue: -{ - friendlyName: string, # Optional. Gets or sets the friendly name of the collection. - name: string, # Optional. Gets the name. -} - - - - - - \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewResourceSetRule.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewResourceSetRule.xml deleted file mode 100644 index 56fab1aae457..000000000000 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/PurviewResourceSetRule.xml +++ /dev/null @@ -1,1305 +0,0 @@ - - - - - -This sample shows how to call GetResourceSetRuleAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -Response response = await client.GetResourceSetRuleAsync(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("modifiedAt").ToString()); -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("resourceSetProcessing").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("typeName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("enableDefaultPatterns").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("dynamicReplacement").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("entityTypes")[0].ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("version").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("condition").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("bindingUrl").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("displayName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("isResourceSet").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("qualifiedName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("storeType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("version").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for ResourceSetRuleConfig: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - - - - - -This sample shows how to call GetResourceSetRule and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -Response response = client.GetResourceSetRule(); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("modifiedAt").ToString()); -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("resourceSetProcessing").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("typeName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("enableDefaultPatterns").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("dynamicReplacement").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("entityTypes")[0].ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("version").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("condition").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("bindingUrl").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("displayName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("isResourceSet").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("qualifiedName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("storeType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("version").ToString()); -]]> - - -Below is the JSON schema for the response payload. - -Response Body: - -Schema for ResourceSetRuleConfig: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - - - - - -This sample shows how to call CreateOrUpdateResourceSetRuleAsync and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -var data = new {}; - -Response response = await client.CreateOrUpdateResourceSetRuleAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call CreateOrUpdateResourceSetRuleAsync with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -var data = new { - advancedResourceSet = new { - modifiedAt = "2022-05-10T18:57:31.2311892Z", - resourceSetProcessing = "Default", - }, - pathPatternConfig = new { - acceptedPatterns = new[] { - new { - createdBy = "", - filterType = "Pattern", - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - path = "", - } - }, - complexReplacers = new[] { - new { - createdBy = "", - description = "", - disabled = true, - disableRecursiveReplacerApplication = true, - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - typeName = "", - } - }, - createdBy = "", - enableDefaultPatterns = true, - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - normalizationRules = new[] { - new { - description = "", - disabled = true, - dynamicReplacement = true, - entityTypes = new[] { - "" - }, - lastUpdatedTimestamp = 1234L, - name = "", - regex = new { - maxDigits = 1234, - maxLetters = 1234, - minDashes = 1234, - minDigits = 1234, - minDigitsOrLetters = 1234, - minDots = 1234, - minHex = 1234, - minLetters = 1234, - minUnderscores = 1234, - options = 1234, - regexStr = "", - }, - replaceWith = "", - version = 123.45d, - } - }, - regexReplacers = new[] { - new { - condition = "", - createdBy = "", - description = "", - disabled = true, - disableRecursiveReplacerApplication = true, - doNotReplaceRegex = new { - maxDigits = 1234, - maxLetters = 1234, - minDashes = 1234, - minDigits = 1234, - minDigitsOrLetters = 1234, - minDots = 1234, - minHex = 1234, - minLetters = 1234, - minUnderscores = 1234, - options = 1234, - regexStr = "", - }, - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - regex = new { - maxDigits = 1234, - maxLetters = 1234, - minDashes = 1234, - minDigits = 1234, - minDigitsOrLetters = 1234, - minDots = 1234, - minHex = 1234, - minLetters = 1234, - minUnderscores = 1234, - options = 1234, - regexStr = "", - }, - replaceWith = "", - } - }, - rejectedPatterns = new[] { - new { - createdBy = "", - filterType = "Pattern", - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - path = "", - } - }, - scopedRules = new[] { - new { - bindingUrl = "", - rules = new[] { - new { - displayName = "", - isResourceSet = true, - lastUpdatedTimestamp = 1234L, - name = "", - qualifiedName = "", - } - }, - storeType = "", - } - }, - version = 1234, - }, -}; - -Response response = await client.CreateOrUpdateResourceSetRuleAsync(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("modifiedAt").ToString()); -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("resourceSetProcessing").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("typeName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("enableDefaultPatterns").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("dynamicReplacement").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("entityTypes")[0].ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("version").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("condition").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("bindingUrl").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("displayName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("isResourceSet").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("qualifiedName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("storeType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("version").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for ResourceSetRuleConfig: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - -Response Body: - -Schema for ResourceSetRuleConfig: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - - - - - -This sample shows how to call CreateOrUpdateResourceSetRule and parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -var data = new {}; - -Response response = client.CreateOrUpdateResourceSetRule(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.ToString()); -]]> -This sample shows how to call CreateOrUpdateResourceSetRule with all request content, and how to parse the result. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -var data = new { - advancedResourceSet = new { - modifiedAt = "2022-05-10T18:57:31.2311892Z", - resourceSetProcessing = "Default", - }, - pathPatternConfig = new { - acceptedPatterns = new[] { - new { - createdBy = "", - filterType = "Pattern", - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - path = "", - } - }, - complexReplacers = new[] { - new { - createdBy = "", - description = "", - disabled = true, - disableRecursiveReplacerApplication = true, - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - typeName = "", - } - }, - createdBy = "", - enableDefaultPatterns = true, - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - normalizationRules = new[] { - new { - description = "", - disabled = true, - dynamicReplacement = true, - entityTypes = new[] { - "" - }, - lastUpdatedTimestamp = 1234L, - name = "", - regex = new { - maxDigits = 1234, - maxLetters = 1234, - minDashes = 1234, - minDigits = 1234, - minDigitsOrLetters = 1234, - minDots = 1234, - minHex = 1234, - minLetters = 1234, - minUnderscores = 1234, - options = 1234, - regexStr = "", - }, - replaceWith = "", - version = 123.45d, - } - }, - regexReplacers = new[] { - new { - condition = "", - createdBy = "", - description = "", - disabled = true, - disableRecursiveReplacerApplication = true, - doNotReplaceRegex = new { - maxDigits = 1234, - maxLetters = 1234, - minDashes = 1234, - minDigits = 1234, - minDigitsOrLetters = 1234, - minDots = 1234, - minHex = 1234, - minLetters = 1234, - minUnderscores = 1234, - options = 1234, - regexStr = "", - }, - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - regex = new { - maxDigits = 1234, - maxLetters = 1234, - minDashes = 1234, - minDigits = 1234, - minDigitsOrLetters = 1234, - minDots = 1234, - minHex = 1234, - minLetters = 1234, - minUnderscores = 1234, - options = 1234, - regexStr = "", - }, - replaceWith = "", - } - }, - rejectedPatterns = new[] { - new { - createdBy = "", - filterType = "Pattern", - lastUpdatedTimestamp = 1234L, - modifiedBy = "", - name = "", - path = "", - } - }, - scopedRules = new[] { - new { - bindingUrl = "", - rules = new[] { - new { - displayName = "", - isResourceSet = true, - lastUpdatedTimestamp = 1234L, - name = "", - qualifiedName = "", - } - }, - storeType = "", - } - }, - version = 1234, - }, -}; - -Response response = client.CreateOrUpdateResourceSetRule(RequestContent.Create(data)); - -JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("modifiedAt").ToString()); -Console.WriteLine(result.GetProperty("advancedResourceSet").GetProperty("resourceSetProcessing").ToString()); -Console.WriteLine(result.GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("acceptedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("complexReplacers")[0].GetProperty("typeName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("enableDefaultPatterns").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("dynamicReplacement").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("entityTypes")[0].ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("normalizationRules")[0].GetProperty("version").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("condition").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("description").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disabled").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("disableRecursiveReplacerApplication").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("doNotReplaceRegex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("maxLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDashes").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigits").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDigitsOrLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minDots").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minHex").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minLetters").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("minUnderscores").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("options").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("regex").GetProperty("regexStr").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("regexReplacers")[0].GetProperty("replaceWith").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("createdBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("filterType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("modifiedBy").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("rejectedPatterns")[0].GetProperty("path").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("bindingUrl").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("displayName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("isResourceSet").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("lastUpdatedTimestamp").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("name").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("rules")[0].GetProperty("qualifiedName").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("scopedRules")[0].GetProperty("storeType").ToString()); -Console.WriteLine(result.GetProperty("pathPatternConfig").GetProperty("version").ToString()); -]]> - - -Below is the JSON schema for the request and response payloads. - -Request Body: - -Schema for ResourceSetRuleConfig: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - -Response Body: - -Schema for ResourceSetRuleConfig: -{ - advancedResourceSet: { - modifiedAt: string (ISO 8601 Format), # Optional. Date at which ResourceSetProcessing property of the account is updated. - resourceSetProcessing: "Default" | "Advanced", # Optional. The advanced resource property of the account. - }, # Optional. Gets or sets the advanced resource set property of the account. - name: string, # Optional. The name of the rule - pathPatternConfig: { - acceptedPatterns: [ - { - createdBy: string, # Optional. - filterType: "Pattern" | "Regex", # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - path: string, # Required. - } - ], # Optional. - complexReplacers: [ - { - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Optional. - disableRecursiveReplacerApplication: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Optional. - typeName: string, # Optional. - } - ], # Optional. - createdBy: string, # Required. - enableDefaultPatterns: boolean, # Required. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - normalizationRules: [ - { - description: string, # Optional. - disabled: boolean, # Optional. - dynamicReplacement: boolean, # Optional. - entityTypes: [string], # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - regex: { - maxDigits: number, # Optional. - maxLetters: number, # Optional. - minDashes: number, # Optional. - minDigits: number, # Optional. - minDigitsOrLetters: number, # Optional. - minDots: number, # Optional. - minHex: number, # Optional. - minLetters: number, # Optional. - minUnderscores: number, # Optional. - options: number, # Optional. - regexStr: string, # Optional. - }, # Optional. - replaceWith: string, # Optional. - version: number, # Optional. - } - ], # Optional. - regexReplacers: [ - { - condition: string, # Optional. - createdBy: string, # Optional. - description: string, # Optional. - disabled: boolean, # Required. - disableRecursiveReplacerApplication: boolean, # Optional. - doNotReplaceRegex: FastRegex, # Optional. - lastUpdatedTimestamp: number, # Optional. - modifiedBy: string, # Optional. - name: string, # Required. - regex: FastRegex, # Optional. - replaceWith: string, # Optional. - } - ], # Optional. - rejectedPatterns: [Filter], # Optional. - scopedRules: [ - { - bindingUrl: string, # Required. - rules: [ - { - displayName: string, # Optional. - isResourceSet: boolean, # Optional. - lastUpdatedTimestamp: number, # Optional. - name: string, # Optional. - qualifiedName: string, # Required. - } - ], # Optional. - storeType: string, # Required. - } - ], # Optional. - version: number, # Optional. - }, # Optional. The configuration rules for path pattern extraction. -} - - - - - - -This sample shows how to call DeleteResourceSetRuleAsync. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -Response response = await client.DeleteResourceSetRuleAsync(); -Console.WriteLine(response.Status); -]]> - - - - -This sample shows how to call DeleteResourceSetRule. -"); -var client = new PurviewAccountClient(endpoint, credential).GetPurviewResourceSetRuleClient(); - -Response response = client.DeleteResourceSetRule(); -Console.WriteLine(response.Status); -]]> - - - - \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedAssetsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedAssetsClient.xml new file mode 100644 index 000000000000..30d4f5c7f298 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedAssetsClient.xml @@ -0,0 +1,103 @@ + + + + + +This sample shows how to call GetReceivedAssetsAsync with required parameters and parse the result. +"); +var client = new ReceivedAssetsClient(endpoint, credential); + +await foreach (var data in client.GetReceivedAssetsAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetReceivedAssetsAsync with all parameters, and how to parse the result. +"); +var client = new ReceivedAssetsClient(endpoint, credential); + +await foreach (var data in client.GetReceivedAssetsAsync("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List received assets for a received share + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ReceivedAssetListValue: +{ + kind: "AdlsGen2Account" | "BlobAccount", # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetReceivedAssets with required parameters and parse the result. +"); +var client = new ReceivedAssetsClient(endpoint, credential); + +foreach (var data in client.GetReceivedAssets("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetReceivedAssets with all parameters, and how to parse the result. +"); +var client = new ReceivedAssetsClient(endpoint, credential); + +foreach (var data in client.GetReceivedAssets("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List received assets for a received share + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ReceivedAssetListValue: +{ + kind: "AdlsGen2Account" | "BlobAccount", # Required. The types of asset. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedInvitationsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedInvitationsClient.xml new file mode 100644 index 000000000000..319e3d2eb881 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedInvitationsClient.xml @@ -0,0 +1,605 @@ + + + + + +This sample shows how to call GetReceivedInvitationAsync with required parameters and parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +Response response = await client.GetReceivedInvitationAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a received invitation + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationReceivedInvitationSchema for ApplicationReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties for a received invitation of kind application. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserReceivedInvitationSchema for UserReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties for a received invitation of kind user. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call GetReceivedInvitation with required parameters and parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +Response response = client.GetReceivedInvitation(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a received invitation + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationReceivedInvitationSchema for ApplicationReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties for a received invitation of kind application. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserReceivedInvitationSchema for UserReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties for a received invitation of kind user. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call RejectAsync with required parameters and request content, and how to parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = await client.RejectAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call RejectAsync with all parameters and request content, and how to parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + shareKind = "InPlace", + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = await client.RejectAsync("", RequestContent.Create(data), ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Reject a received invitation + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationReceivedInvitationSchema for ApplicationReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties for a received invitation of kind application. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserReceivedInvitationSchema for UserReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties for a received invitation of kind user. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationReceivedInvitationSchema for ApplicationReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties for a received invitation of kind application. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserReceivedInvitationSchema for UserReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties for a received invitation of kind user. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call Reject with required parameters and request content, and how to parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = client.Reject("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Reject with all parameters and request content, and how to parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + shareKind = "InPlace", + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = client.Reject("", RequestContent.Create(data), ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Reject a received invitation + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationReceivedInvitationSchema for ApplicationReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties for a received invitation of kind application. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserReceivedInvitationSchema for UserReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties for a received invitation of kind user. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationReceivedInvitationSchema for ApplicationReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties for a received invitation of kind application. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserReceivedInvitationSchema for UserReceivedInvitation: +{ + properties: { + description: string, # Optional. Description shared when the invitation was created + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the received share created by accepting the invitation. + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + location: string, # Optional. Location of the invitation. + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + sentShareName: string, # Optional. Gets the source share Name. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties for a received invitation of kind user. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call GetReceivedInvitationsAsync and parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +await foreach (var data in client.GetReceivedInvitationsAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetReceivedInvitationsAsync with all parameters, and how to parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +await foreach (var data in client.GetReceivedInvitationsAsync("", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List received invitations + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ReceivedInvitationListValue: +{ + invitationKind: "User" | "Application", # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetReceivedInvitations and parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +foreach (var data in client.GetReceivedInvitations()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetReceivedInvitations with all parameters, and how to parse the result. +"); +var client = new ReceivedInvitationsClient(endpoint, credential); + +foreach (var data in client.GetReceivedInvitations("", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List received invitations + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ReceivedInvitationListValue: +{ + invitationKind: "User" | "Application", # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedSharesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedSharesClient.xml new file mode 100644 index 000000000000..a50a0407fde7 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ReceivedSharesClient.xml @@ -0,0 +1,509 @@ + + + + + +This sample shows how to call GetReceivedShareAsync with required parameters and parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +Response response = await client.GetReceivedShareAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a received share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceReceivedShareSchema for InPlaceReceivedShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created. + expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share. + invitationId: string, # Required. The invitation id. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentShareDescription: string, # Optional. Share description. + sentShareLocation: string, # Required. Sent share location. + sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared. + shareName: string, # Optional. Name of the share + }, # Required. Properties of in place received share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call GetReceivedShare with required parameters and parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +Response response = client.GetReceivedShare(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a received share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceReceivedShareSchema for InPlaceReceivedShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created. + expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share. + invitationId: string, # Required. The invitation id. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentShareDescription: string, # Optional. Share description. + sentShareLocation: string, # Required. Sent share location. + sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared. + shareName: string, # Optional. Name of the share + }, # Required. Properties of in place received share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call CreateAsync with required parameters and request content, and how to parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + invitationId = "", + sentShareLocation = "", + }, + shareKind = "InPlace", +}; + +Response response = await client.CreateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateAsync with all parameters and request content, and how to parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + expirationDate = "2022-05-10T18:57:31.2311892Z", + invitationId = "", + sentShareDescription = "", + sentShareLocation = "", + }, + shareKind = "InPlace", +}; + +Response response = await client.CreateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create a received share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceReceivedShareSchema for InPlaceReceivedShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created. + expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share. + invitationId: string, # Required. The invitation id. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentShareDescription: string, # Optional. Share description. + sentShareLocation: string, # Required. Sent share location. + sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared. + shareName: string, # Optional. Name of the share + }, # Required. Properties of in place received share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceReceivedShareSchema for InPlaceReceivedShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created. + expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share. + invitationId: string, # Required. The invitation id. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentShareDescription: string, # Optional. Share description. + sentShareLocation: string, # Required. Sent share location. + sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared. + shareName: string, # Optional. Name of the share + }, # Required. Properties of in place received share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call Create with required parameters and request content, and how to parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + invitationId = "", + sentShareLocation = "", + }, + shareKind = "InPlace", +}; + +Response response = client.Create("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Create with all parameters and request content, and how to parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + expirationDate = "2022-05-10T18:57:31.2311892Z", + invitationId = "", + sentShareDescription = "", + sentShareLocation = "", + }, + shareKind = "InPlace", +}; + +Response response = client.Create("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create a received share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceReceivedShareSchema for InPlaceReceivedShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created. + expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share. + invitationId: string, # Required. The invitation id. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentShareDescription: string, # Optional. Share description. + sentShareLocation: string, # Required. Sent share location. + sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared. + shareName: string, # Optional. Name of the share + }, # Required. Properties of in place received share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceReceivedShareSchema for InPlaceReceivedShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created. + expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share. + invitationId: string, # Required. The invitation id. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status + receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation + receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation + receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation + senderEmail: string, # Optional. Email of the sender who created the sent share invitation + senderName: string, # Optional. Name of the sender who created the sent share invitation + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation + sentShareDescription: string, # Optional. Share description. + sentShareLocation: string, # Required. Sent share location. + sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared. + shareName: string, # Optional. Name of the share + }, # Required. Properties of in place received share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call GetReceivedSharesAsync and parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +await foreach (var data in client.GetReceivedSharesAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetReceivedSharesAsync with all parameters, and how to parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +await foreach (var data in client.GetReceivedSharesAsync("", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List received shares + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ReceivedShareListValue: +{ + shareKind: "InPlace", # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetReceivedShares and parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +foreach (var data in client.GetReceivedShares()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetReceivedShares with all parameters, and how to parse the result. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +foreach (var data in client.GetReceivedShares("", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List received shares + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ReceivedShareListValue: +{ + shareKind: "InPlace", # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call DeleteAsync with required parameters. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +var operation = await client.DeleteAsync(WaitUntil.Completed, ""); + +var response = await operation.WaitForCompletionResponseAsync(); +Console.WriteLine(response.Status) +]]> + + +Delete a received share + + + + +This sample shows how to call Delete with required parameters. +"); +var client = new ReceivedSharesClient(endpoint, credential); + +var operation = client.Delete(WaitUntil.Completed, ""); + +var response = operation.WaitForCompletionResponse(); +Console.WriteLine(response.Status) +]]> + + +Delete a received share + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/RelationshipClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/RelationshipClient.xml new file mode 100644 index 000000000000..978ace4003eb --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/RelationshipClient.xml @@ -0,0 +1,977 @@ + + + + + +This sample shows how to call CreateAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateAsync with all request content, and how to parse the result. +", credential); + +var data = new { + createTime = 123.45f, + createdBy = "", + end1 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + end2 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + guid = "", + homeId = "", + label = " + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + +Response Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call Create and parse the result. +", credential); + +var data = new {}; + +Response response = client.Create(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Create with all request content, and how to parse the result. +", credential); + +var data = new { + createTime = 123.45f, + createdBy = "", + end1 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + end2 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + guid = "", + homeId = "", + label = " + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + +Response Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call UpdateAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.UpdateAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateAsync with all request content, and how to parse the result. +", credential); + +var data = new { + createTime = 123.45f, + createdBy = "", + end1 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + end2 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + guid = "", + homeId = "", + label = " + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + +Response Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call Update and parse the result. +", credential); + +var data = new {}; + +Response response = client.Update(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call Update with all request content, and how to parse the result. +", credential); + +var data = new { + createTime = 123.45f, + createdBy = "", + end1 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + end2 = new { + displayText = "", + entityStatus = "ACTIVE", + relationshipType = "", + relationshipAttributes = new { + entityGuid = "", + entityStatus = "ACTIVE", + removePropagationsOnEntityDelete = true, + validityPeriods = new[] { + new { + endTime = "", + startTime = "", + timeZone = "", + } + }, + source = "", + sourceDetails = new { + key = new {}, + }, + attributes = new { + key = new {}, + }, + typeName = "", + lastModifiedTS = "", + }, + relationshipGuid = "", + relationshipStatus = "ACTIVE", + guid = "", + typeName = "", + uniqueAttributes = new { + key = new {}, + }, + }, + guid = "", + homeId = "", + label = " + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + +Response Body: + +Schema for AtlasRelationship: +{ + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetRelationshipAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetRelationshipAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetRelationshipAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetRelationshipAsync("", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end1").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end1").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end1").GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end2").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end2").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end2").GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("label").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelationshipWithExtInfo: +{ + referredEntities: Dictionary<string, AtlasEntityHeader>, # Optional. The referred entity header. + relationship: { + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Atlas relationship instance. +} + + + + + + +This sample shows how to call GetRelationship with required parameters and parse the result. +", credential); + +Response response = client.GetRelationship(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetRelationship with all parameters, and how to parse the result. +", credential); + +Response response = client.GetRelationship("", true); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classificationNames")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("entityStatus").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("sourceDetails").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("isIncomplete").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("labels")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meaningNames")[0].ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("confidence").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("displayText").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("expression").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("relationGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("source").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("steward").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("meanings")[0].GetProperty("termGuid").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("referredEntities").GetProperty("").GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end1").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end1").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end1").GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end2").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end2").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("end2").GetProperty("uniqueAttributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("homeId").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("label").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("provenanceType").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("attributes").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationship").GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelationshipWithExtInfo: +{ + referredEntities: Dictionary<string, AtlasEntityHeader>, # Optional. The referred entity header. + relationship: { + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + end1: { + guid: string, # Optional. The GUID of the object. + typeName: string, # Optional. The name of the type. + uniqueAttributes: Dictionary<string, AnyObject>, # Optional. The unique attributes of the object. + }, # Optional. Reference to an object-instance of an Atlas type - like entity. + end2: AtlasObjectId, # Optional. Reference to an object-instance of an Atlas type - like entity. + guid: string, # Optional. The GUID of the relationship. + homeId: string, # Optional. The home ID of the relationship. + label: string, # Optional. The label of the relationship. + provenanceType: number, # Optional. Used to record the provenance of an instance of an entity or relationship + status: "ACTIVE" | "DELETED", # Optional. The enum of relationship status. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the relationship. + attributes: Dictionary<string, AnyObject>, # Optional. The attributes of the struct. + typeName: string, # Optional. The name of the type. + lastModifiedTS: string, # Optional. ETag for concurrency control. + }, # Optional. Atlas relationship instance. +} + + + + + + +This sample shows how to call DeleteAsync with required parameters. +", credential); + +Response response = await client.DeleteAsync(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call Delete with required parameters. +", credential); + +Response response = client.Delete(""); +Console.WriteLine(response.Status); +]]> + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScanResultClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScanResultClient.xml new file mode 100644 index 000000000000..c9ecc14b5211 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScanResultClient.xml @@ -0,0 +1,405 @@ + + + + + +This sample shows how to call RunScanAsync with required parameters and parse the result. +", credential); + +Response response = await client.RunScanAsync("", "", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call RunScanAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.RunScanAsync("", "", "", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("scanResultId").ToString()); +Console.WriteLine(result.GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("status").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("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for OperationResponse: +{ + scanResultId: Guid, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + status: "Accepted" | "InProgress" | "TransientFailure" | "Succeeded" | "Failed" | "Canceled", # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorInfo], # Optional. + } + ], # Optional. + }, # Optional. +} + + + + + + +This sample shows how to call RunScan with required parameters and parse the result. +", credential); + +Response response = client.RunScan("", "", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call RunScan with all parameters, and how to parse the result. +", credential); + +Response response = client.RunScan("", "", "", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("scanResultId").ToString()); +Console.WriteLine(result.GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("status").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("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for OperationResponse: +{ + scanResultId: Guid, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + status: "Accepted" | "InProgress" | "TransientFailure" | "Succeeded" | "Failed" | "Canceled", # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorInfo], # Optional. + } + ], # Optional. + }, # Optional. +} + + + + + + +This sample shows how to call CancelScanAsync with required parameters and parse the result. +", credential); + +Response response = await client.CancelScanAsync("", "", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("scanResultId").ToString()); +Console.WriteLine(result.GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("status").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("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for OperationResponse: +{ + scanResultId: Guid, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + status: "Accepted" | "InProgress" | "TransientFailure" | "Succeeded" | "Failed" | "Canceled", # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorInfo], # Optional. + } + ], # Optional. + }, # Optional. +} + + + + + + +This sample shows how to call CancelScan with required parameters and parse the result. +", credential); + +Response response = client.CancelScan("", "", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("scanResultId").ToString()); +Console.WriteLine(result.GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("status").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("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for OperationResponse: +{ + scanResultId: Guid, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + status: "Accepted" | "InProgress" | "TransientFailure" | "Succeeded" | "Failed" | "Canceled", # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorInfo], # Optional. + } + ], # Optional. + }, # Optional. +} + + + + + + +This sample shows how to call GetScanHistoriesAsync with required parameters and parse the result. +", credential); + +await foreach (var data in client.GetScanHistoriesAsync("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("parentId").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("resourceId").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("assetsDiscovered").ToString()); + Console.WriteLine(result.GetProperty("assetsClassified").ToString()); + Console.WriteLine(result.GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); + Console.WriteLine(result.GetProperty("startTime").ToString()); + Console.WriteLine(result.GetProperty("queuedTime").ToString()); + Console.WriteLine(result.GetProperty("pipelineStartTime").ToString()); + Console.WriteLine(result.GetProperty("endTime").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetVersion").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("scanLevelType").ToString()); + Console.WriteLine(result.GetProperty("errorMessage").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("details")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("runType").ToString()); + Console.WriteLine(result.GetProperty("dataSourceType").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ScanHistoryListValue: +{ + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. +} + + + + + + +This sample shows how to call GetScanHistories with required parameters and parse the result. +", credential); + +foreach (var data in client.GetScanHistories("", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("parentId").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("resourceId").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("assetsDiscovered").ToString()); + Console.WriteLine(result.GetProperty("assetsClassified").ToString()); + Console.WriteLine(result.GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); + Console.WriteLine(result.GetProperty("startTime").ToString()); + Console.WriteLine(result.GetProperty("queuedTime").ToString()); + Console.WriteLine(result.GetProperty("pipelineStartTime").ToString()); + Console.WriteLine(result.GetProperty("endTime").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetVersion").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("scanLevelType").ToString()); + Console.WriteLine(result.GetProperty("errorMessage").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("details")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("runType").ToString()); + Console.WriteLine(result.GetProperty("dataSourceType").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ScanHistoryListValue: +{ + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScanRulesetsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScanRulesetsClient.xml new file mode 100644 index 000000000000..bfe809eaa670 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScanRulesetsClient.xml @@ -0,0 +1,4475 @@ + + + + + +This sample shows how to call GetScanRulesetAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetScanRulesetAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetScanRuleset with required parameters and parse the result. +", credential); + +Response response = client.GetScanRuleset(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "AzureSubscription", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + description = "", + excludedSystemClassifications = new[] { + "" + }, + includedCustomClassificationRuleNames = new[] { + "" + }, + }, + kind = "AzureSubscription", + scanRulesetType = "Custom", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdate with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "AzureSubscription", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + description = "", + excludedSystemClassifications = new[] { + "" + }, + includedCustomClassificationRuleNames = new[] { + "" + }, + }, + kind = "AzureSubscription", + scanRulesetType = "Custom", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call DeleteAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call Delete with required parameters and parse the result. +", credential); + +Response response = client.Delete(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionScanRulesetSchema for AzureSubscriptionScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSubscription, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupScanRulesetSchema for AzureResourceGroupScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureResourceGroup, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceScanRulesetSchema for AzureSynapseWorkspaceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapseWorkspace, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseScanRulesetSchema for AzureSynapseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSynapse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1ScanRulesetSchema for AdlsGen1ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen1, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2ScanRulesetSchema for AdlsGen2ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AdlsGen2, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountScanRulesetSchema for AmazonAccountScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonAccount, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3ScanRulesetSchema for AmazonS3ScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonS3, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlScanRulesetSchema for AmazonSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbScanRulesetSchema for AzureCosmosDbScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureCosmosDb, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerScanRulesetSchema for AzureDataExplorerScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureDataExplorer, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceScanRulesetSchema for AzureFileServiceScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureFileService, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseScanRulesetSchema for AzureSqlDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlScanRulesetSchema for AmazonPostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AmazonPostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlScanRulesetSchema for AzurePostgreSqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzurePostgreSql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseScanRulesetSchema for SqlServerDatabaseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SqlServerDatabase, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceScanRulesetSchema for AzureSqlDatabaseManagedInstanceScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstance, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseScanRulesetSchema for AzureSqlDataWarehouseScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureSqlDataWarehouse, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlScanRulesetSchema for AzureMySqlScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureMySql, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageScanRulesetSchema for AzureStorageScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: AzureStorage, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataScanRulesetSchema for TeradataScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Teradata, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleScanRulesetSchema for OracleScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: Oracle, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaScanRulesetSchema for SapS4HanaScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapS4Hana, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccScanRulesetSchema for SapEccScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: SapEcc, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIScanRulesetSchema for PowerBIScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: PowerBI, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetScanRulesetsAsync and parse the result. +", credential); + +await foreach (var data in client.GetScanRulesetsAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ScanRulesetListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetScanRulesets and parse the result. +", credential); + +foreach (var data in client.GetScanRulesets()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ScanRulesetListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScansClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScansClient.xml new file mode 100644 index 000000000000..4115214a5cdb --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/ScansClient.xml @@ -0,0 +1,28357 @@ + + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "AzureSubscriptionCredential", +}; + +Response response = await client.CreateOrUpdateAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + resourceTypes = new { + None = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSubscription = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureResourceGroup = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSynapseWorkspace = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSynapse = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AdlsGen1 = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AdlsGen2 = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonAccount = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonS3 = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonSql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureCosmosDb = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureDataExplorer = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureFileService = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSqlDatabase = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonPostgreSql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzurePostgreSql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + SqlServerDatabase = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSqlDatabaseManagedInstance = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSqlDataWarehouse = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureMySql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureStorage = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + Teradata = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + Oracle = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + SapS4Hana = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + SapEcc = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + PowerBI = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + scanRulesetName = "", + scanRulesetType = "Custom", + collection = new { + referenceName = "", + type = "", + }, + workers = 1234, + connectedVia = new { + referenceName = "", + }, + }, + kind = "AzureSubscriptionCredential", +}; + +Response response = await client.CreateOrUpdateAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdate with required parameters and request content, and how to parse the result. +", credential); + +var data = new { + kind = "AzureSubscriptionCredential", +}; + +Response response = client.CreateOrUpdate("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + resourceTypes = new { + None = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSubscription = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureResourceGroup = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSynapseWorkspace = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSynapse = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AdlsGen1 = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AdlsGen2 = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonAccount = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonS3 = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonSql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureCosmosDb = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureDataExplorer = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureFileService = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSqlDatabase = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AmazonPostgreSql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzurePostgreSql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + SqlServerDatabase = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSqlDatabaseManagedInstance = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureSqlDataWarehouse = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureMySql = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + AzureStorage = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + Teradata = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + Oracle = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + SapS4Hana = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + SapEcc = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + PowerBI = new { + scanRulesetName = "", + scanRulesetType = "Custom", + resourceNameFilter = new { + excludePrefixes = new[] { + "" + }, + includePrefixes = new[] { + "" + }, + resources = new[] { + "" + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + }, + }, + credential = new { + referenceName = "", + credentialType = "AccountKey", + }, + scanRulesetName = "", + scanRulesetType = "Custom", + collection = new { + referenceName = "", + type = "", + }, + workers = 1234, + connectedVia = new { + referenceName = "", + }, + }, + kind = "AzureSubscriptionCredential", +}; + +Response response = client.CreateOrUpdate("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetScanAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetScanAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetScan with required parameters and parse the result. +", credential); + +Response response = client.GetScan("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call DeleteAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call Delete with required parameters and parse the result. +", credential); + +Response response = client.Delete("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); +Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionCredentialScanSchema for AzureSubscriptionCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 42 more JSON objects
AzureSubscriptionMsiScanSchema for AzureSubscriptionMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSubscriptionMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupCredentialScanSchema for AzureResourceGroupCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureResourceGroupMsiScanSchema for AzureResourceGroupMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureResourceGroupMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceCredentialScanSchema for AzureSynapseWorkspaceCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceMsiScanSchema for AzureSynapseWorkspaceMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseWorkspaceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseCredentialScanSchema for AzureSynapseCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseMsiScanSchema for AzureSynapseMsiScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSynapseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1CredentialScanSchema for AdlsGen1CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1MsiScanSchema for AdlsGen1MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen1Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2CredentialScanSchema for AdlsGen2CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2MsiScanSchema for AdlsGen2MsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AdlsGen2Msi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountCredentialScanSchema for AmazonAccountCredentialScan: +{ + properties: { + resourceTypes: { + None: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + resourceNameFilter: { + excludePrefixes: [string], # Optional. + includePrefixes: [string], # Optional. + resources: [string], # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + }, # Optional. + AzureSubscription: ResourceTypeFilter, # Optional. + AzureResourceGroup: ResourceTypeFilter, # Optional. + AzureSynapseWorkspace: ResourceTypeFilter, # Optional. + AzureSynapse: ResourceTypeFilter, # Optional. + AdlsGen1: ResourceTypeFilter, # Optional. + AdlsGen2: ResourceTypeFilter, # Optional. + AmazonAccount: ResourceTypeFilter, # Optional. + AmazonS3: ResourceTypeFilter, # Optional. + AmazonSql: ResourceTypeFilter, # Optional. + AzureCosmosDb: ResourceTypeFilter, # Optional. + AzureDataExplorer: ResourceTypeFilter, # Optional. + AzureFileService: ResourceTypeFilter, # Optional. + AzureSqlDatabase: ResourceTypeFilter, # Optional. + AmazonPostgreSql: ResourceTypeFilter, # Optional. + AzurePostgreSql: ResourceTypeFilter, # Optional. + SqlServerDatabase: ResourceTypeFilter, # Optional. + AzureSqlDatabaseManagedInstance: ResourceTypeFilter, # Optional. + AzureSqlDataWarehouse: ResourceTypeFilter, # Optional. + AzureMySql: ResourceTypeFilter, # Optional. + AzureStorage: ResourceTypeFilter, # Optional. + Teradata: ResourceTypeFilter, # Optional. + Oracle: ResourceTypeFilter, # Optional. + SapS4Hana: ResourceTypeFilter, # Optional. + SapEcc: ResourceTypeFilter, # Optional. + PowerBI: ResourceTypeFilter, # Optional. + }, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonAccountCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3CredentialScanSchema for AmazonS3CredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3Credential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3RoleARNScanSchema for AmazonS3RoleARNScan: +{ + properties: { + roleARN: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonS3RoleARN, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlCredentialScanSchema for AmazonSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbCredentialScanSchema for AzureCosmosDbCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureCosmosDbCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerCredentialScanSchema for AzureDataExplorerCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerMsiScanSchema for AzureDataExplorerMsiScan: +{ + properties: { + database: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureDataExplorerMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceCredentialScanSchema for AzureFileServiceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + shareName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureFileServiceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseCredentialScanSchema for AzureSqlDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseMsiScanSchema for AzureSqlDatabaseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlCredentialScanSchema for AmazonPostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AmazonPostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlCredentialScanSchema for AzurePostgreSqlCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + port: number, # Optional. + sslMode: number, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzurePostgreSqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseCredentialScanSchema for SqlServerDatabaseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SqlServerDatabaseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceCredentialScanSchema for AzureSqlDatabaseManagedInstanceCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceMsiScanSchema for AzureSqlDatabaseManagedInstanceMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDatabaseManagedInstanceMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseCredentialScanSchema for AzureSqlDataWarehouseCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseMsiScanSchema for AzureSqlDataWarehouseMsiScan: +{ + properties: { + serverEndpoint: string, # Optional. + databaseName: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureSqlDataWarehouseMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlCredentialScanSchema for AzureMySqlCredentialScan: +{ + properties: { + serverEndpoint: string, # Optional. + port: number, # Optional. + databaseName: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureMySqlCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageCredentialScanSchema for AzureStorageCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageMsiScanSchema for AzureStorageMsiScan: +{ + properties: { + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: AzureStorageMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataCredentialScanSchema for TeradataCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataUserPassScanSchema for TeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataTeradataUserPassScanSchema for TeradataTeradataUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: TeradataTeradataUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleCredentialScanSchema for OracleCredentialScan: +{ + properties: { + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleUserPassScanSchema for OracleUserPassScan: +{ + properties: { + username: string, # Optional. + password: string, # Optional. + schema: string, # Optional. + driverLocation: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: OracleOracleUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaCredentialScanSchema for SapS4HanaSapS4HanaCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSapS4HanaUserPassScanSchema for SapS4HanaSapS4HanaUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapS4HanaSapS4HanaUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccCredentialScanSchema for SapEccCredentialScan: +{ + properties: { + clientId: string, # Optional. + credential: { + referenceName: string, # Optional. + credentialType: "AccountKey" | "ServicePrincipal" | "BasicAuth" | "SqlAuth" | "AmazonARN", # Optional. + }, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccCredential, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccUserPassScanSchema for SapEccUserPassScan: +{ + properties: { + clientId: string, # Optional. + username: string, # Optional. + password: string, # Optional. + jCoLibraryPath: string, # Optional. + maximumMemoryAllowedInGb: string, # Optional. + mitiCache: string, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: SapEccSapEccUserPass, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIDelegatedScanSchema for PowerBIDelegatedScan: +{ + properties: { + tenant: string, # Optional. + authenticationType: string, # Optional. + clientId: string, # Optional. + userName: string, # Optional. + password: string, # Optional. + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIDelegated, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBIMsiScanSchema for PowerBIMsiScan: +{ + properties: { + includePersonalWorkspaces: boolean, # Optional. + scanRulesetName: string, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + collection: { + lastModifiedAt: string (ISO 8601 Format), # Optional. + referenceName: string, # Optional. + type: string, # Optional. + }, # Optional. + workers: number, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + connectedVia: { + referenceName: string, # Optional. + }, # Optional. + }, # Optional. + kind: PowerBIMsi, # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetScansByDataSourceAsync with required parameters and parse the result. +", credential); + +await foreach (var data in client.GetScansByDataSourceAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ScanListValue: +{ + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetScansByDataSource with required parameters and parse the result. +", credential); + +foreach (var data in client.GetScansByDataSource("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("parentId").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("resourceId").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsDiscovered").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("assetsClassified").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("notifications")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("diagnostics").GetProperty("exceptionCountMap").GetProperty("").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("startTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("queuedTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("pipelineStartTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("endTime").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetVersion").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("scanLevelType").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("errorMessage").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("code").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("error").GetProperty("details")[0].GetProperty("target").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("runType").ToString()); + Console.WriteLine(result.GetProperty("scanResults")[0].GetProperty("dataSourceType").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for ScanListValue: +{ + kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi", # Required. + scanResults: [ + { + parentId: string, # Optional. + id: string, # Optional. + resourceId: string, # Optional. + status: string, # Optional. + assetsDiscovered: number, # Optional. + assetsClassified: number, # Optional. + diagnostics: { + notifications: [ + { + message: string, # Optional. + code: number, # Optional. + } + ], # Optional. + exceptionCountMap: Dictionary<string, number>, # Optional. Dictionary of <integer> + }, # Optional. + startTime: string (ISO 8601 Format), # Optional. + queuedTime: string (ISO 8601 Format), # Optional. + pipelineStartTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + scanRulesetVersion: number, # Optional. + scanRulesetType: "Custom" | "System", # Optional. + scanLevelType: "Full" | "Incremental", # Optional. + errorMessage: string, # Optional. + error: { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ + { + code: string, # Optional. + message: string, # Optional. + target: string, # Optional. + details: [ErrorModel], # Optional. + } + ], # Optional. + }, # Optional. + runType: string, # Optional. + dataSourceType: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Optional. + } + ], # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SentShareInvitationsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SentShareInvitationsClient.xml new file mode 100644 index 000000000000..6593beb3bd57 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SentShareInvitationsClient.xml @@ -0,0 +1,591 @@ + + + + + +This sample shows how to call GetSentShareInvitationAsync with required parameters and parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +Response response = await client.GetSentShareInvitationAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a sent share invitation + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationInvitationSchema for ApplicationInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties of the application invitation type. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserInvitationSchema for UserInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties of the user invitation type. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call GetSentShareInvitation with required parameters and parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +Response response = client.GetSentShareInvitation("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a sent share invitation + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationInvitationSchema for ApplicationInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties of the application invitation type. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserInvitationSchema for UserInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties of the user invitation type. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and request content, and how to parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = await client.CreateOrUpdateAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + expirationDate = "2022-05-10T18:57:31.2311892Z", + shareKind = "InPlace", + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = await client.CreateOrUpdateAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create a sent share invitation + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationInvitationSchema for ApplicationInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties of the application invitation type. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserInvitationSchema for UserInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties of the user invitation type. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationInvitationSchema for ApplicationInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties of the application invitation type. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserInvitationSchema for UserInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties of the user invitation type. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call CreateOrUpdate with required parameters and request content, and how to parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = client.CreateOrUpdate("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +var data = new { + properties = new { + expirationDate = "2022-05-10T18:57:31.2311892Z", + shareKind = "InPlace", + targetActiveDirectoryId = "", + targetObjectId = "", + }, + invitationKind = "Application", +}; + +Response response = client.CreateOrUpdate("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("invitationKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create a sent share invitation + +Below is the JSON schema for the request and response payloads. + +Request Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationInvitationSchema for ApplicationInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties of the application invitation type. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserInvitationSchema for UserInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties of the user invitation type. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
ApplicationInvitationSchema for ApplicationInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetActiveDirectoryId: string, # Required. The target azure active directory id the invitation is sent to. + targetObjectId: string, # Required. The target object id in the azure active directory the invitation is sent to. + }, # Required. Properties of the application invitation type. + invitationKind: Application, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
~+ 1 more JSON objects
UserInvitationSchema for UserInvitation: +{ + properties: { + expirationDate: string (ISO 8601 Format), # Optional. The expiration date for the invitation + invitationId: string, # Optional. Id of the invitation + invitationStatus: "Pending" | "Accepted" | "Rejected", # Optional. Status of the invitation. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + respondedAt: string (ISO 8601 Format), # Optional. The time the recipient responded to the invitation. + senderEmail: string, # Optional. Email address of the sender. + senderName: string, # Optional. Name of the sender + senderTenantName: string, # Optional. Tenant name of the sender + sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. + shareKind: "InPlace", # Optional. Defines the supported types for share. + targetEmail: string, # Required. The receiver email for the invitation is being sent. + }, # Required. Properties of the user invitation type. + invitationKind: User, # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+
+ + + + + +This sample shows how to call DeleteAsync with required parameters. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +Response response = await client.DeleteAsync("", ""); +Console.WriteLine(response.Status); +]]> + + +Delete a sent share invitation + + + + +This sample shows how to call Delete with required parameters. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +Response response = client.Delete("", ""); +Console.WriteLine(response.Status); +]]> + + +Delete a sent share invitation + + + + +This sample shows how to call GetSentShareInvitationsAsync with required parameters and parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +await foreach (var data in client.GetSentShareInvitationsAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetSentShareInvitationsAsync with all parameters, and how to parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +await foreach (var data in client.GetSentShareInvitationsAsync("", "", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List sent share invitations + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SentShareInvitationListValue: +{ + invitationKind: "User" | "Application", # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetSentShareInvitations with required parameters and parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +foreach (var data in client.GetSentShareInvitations("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetSentShareInvitations with all parameters, and how to parse the result. +"); +var client = new SentShareInvitationsClient(endpoint, credential); + +foreach (var data in client.GetSentShareInvitations("", "", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("invitationKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +List sent share invitations + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SentShareInvitationListValue: +{ + invitationKind: "User" | "Application", # Required. The types of invitations. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SentSharesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SentSharesClient.xml new file mode 100644 index 000000000000..25c9fe130261 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SentSharesClient.xml @@ -0,0 +1,445 @@ + + + + + +This sample shows how to call GetSentShareAsync with required parameters and parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +Response response = await client.GetSentShareAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a sent share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceSentShareSchema for InPlaceSentShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the share was created. + description: string, # Optional. Share description. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + senderEmail: string, # Optional. Email of the sender who created the sent share. + senderName: string, # Optional. Name of the sender who created the sent share. + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share. + }, # Required. Properties of in place sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call GetSentShare with required parameters and parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +Response response = client.GetSentShare(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Get a sent share + +Below is the JSON schema for the response payload. + +Response Body: + +
InPlaceSentShareSchema for InPlaceSentShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the share was created. + description: string, # Optional. Share description. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + senderEmail: string, # Optional. Email of the sender who created the sent share. + senderName: string, # Optional. Name of the sender who created the sent share. + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share. + }, # Required. Properties of in place sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call CreateOrUpdateAsync with required parameters and request content, and how to parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + }, + shareKind = "InPlace", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdateAsync with all parameters and request content, and how to parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + description = "", + }, + shareKind = "InPlace", +}; + +Response response = await client.CreateOrUpdateAsync("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create a sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceSentShareSchema for InPlaceSentShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the share was created. + description: string, # Optional. Share description. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + senderEmail: string, # Optional. Email of the sender who created the sent share. + senderName: string, # Optional. Name of the sender who created the sent share. + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share. + }, # Required. Properties of in place sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceSentShareSchema for InPlaceSentShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the share was created. + description: string, # Optional. Share description. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + senderEmail: string, # Optional. Email of the sender who created the sent share. + senderName: string, # Optional. Name of the sender who created the sent share. + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share. + }, # Required. Properties of in place sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call CreateOrUpdate with required parameters and request content, and how to parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + }, + shareKind = "InPlace", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateOrUpdate with all parameters and request content, and how to parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +var data = new { + properties = new { + collection = new { + referenceName = "", + type = "", + }, + description = "", + }, + shareKind = "InPlace", +}; + +Response response = client.CreateOrUpdate("", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("shareKind").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +]]> + + +Create a sent share + +Below is the JSON schema for the request and response payloads. + +Request Body: + +
InPlaceSentShareSchema for InPlaceSentShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the share was created. + description: string, # Optional. Share description. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + senderEmail: string, # Optional. Email of the sender who created the sent share. + senderName: string, # Optional. Name of the sender who created the sent share. + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share. + }, # Required. Properties of in place sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ +Response Body: + +
InPlaceSentShareSchema for InPlaceSentShare: +{ + properties: { + collection: { + referenceName: string, # Required. Gets or sets the reference name. + type: string, # Required. Gets or sets the reference type property. + }, # Required. Reference to a Collection. + createdAt: string (ISO 8601 Format), # Optional. Time at which the share was created. + description: string, # Optional. Share description. + provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource + senderEmail: string, # Optional. Email of the sender who created the sent share. + senderName: string, # Optional. Name of the sender who created the sent share. + senderTenantName: string, # Optional. Tenant name of the sender who created the sent share. + }, # Required. Properties of in place sent share. + shareKind: InPlace, # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + +
+ + + + + +This sample shows how to call GetSentSharesAsync and parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +await foreach (var data in client.GetSentSharesAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetSentSharesAsync with all parameters, and how to parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +await foreach (var data in client.GetSentSharesAsync("", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +Get list of sent shares + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SentShareListValue: +{ + shareKind: "InPlace", # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call GetSentShares and parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +foreach (var data in client.GetSentShares()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetSentShares with all parameters, and how to parse the result. +"); +var client = new SentSharesClient(endpoint, credential); + +foreach (var data in client.GetSentShares("", "", "")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("shareKind").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); +} +]]> + + +Get list of sent shares + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SentShareListValue: +{ + shareKind: "InPlace", # Required. Defines the supported types for share. + id: string, # Optional. The resource id of the resource. + name: string, # Optional. Name of the resource. + type: string, # Optional. Type of the resource. +} + + + + + + +This sample shows how to call DeleteAsync with required parameters. +"); +var client = new SentSharesClient(endpoint, credential); + +var operation = await client.DeleteAsync(WaitUntil.Completed, ""); + +var response = await operation.WaitForCompletionResponseAsync(); +Console.WriteLine(response.Status) +]]> + + +Delete a sent share + + + + +This sample shows how to call Delete with required parameters. +"); +var client = new SentSharesClient(endpoint, credential); + +var operation = client.Delete(WaitUntil.Completed, ""); + +var response = operation.WaitForCompletionResponse(); +Console.WriteLine(response.Status) +]]> + + +Delete a sent share + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SystemScanRulesetsClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SystemScanRulesetsClient.xml new file mode 100644 index 000000000000..335a8ed13339 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/SystemScanRulesetsClient.xml @@ -0,0 +1,3509 @@ + + + + + +This sample shows how to call GetSystemScanRulesetAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetSystemScanRulesetAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionSystemScanRulesetSchema for AzureSubscriptionSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupSystemScanRulesetSchema for AzureResourceGroupSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceSystemScanRulesetSchema for AzureSynapseWorkspaceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseSystemScanRulesetSchema for AzureSynapseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1SystemScanRulesetSchema for AdlsGen1SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2SystemScanRulesetSchema for AdlsGen2SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountSystemScanRulesetSchema for AmazonAccountSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3SystemScanRulesetSchema for AmazonS3SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlSystemScanRulesetSchema for AmazonSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbSystemScanRulesetSchema for AzureCosmosDbSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerSystemScanRulesetSchema for AzureDataExplorerSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceSystemScanRulesetSchema for AzureFileServiceSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseSystemScanRulesetSchema for AzureSqlDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlSystemScanRulesetSchema for AmazonPostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlSystemScanRulesetSchema for AzurePostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseSystemScanRulesetSchema for SqlServerDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceSystemScanRulesetSchema for AzureSqlDatabaseManagedInstanceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseSystemScanRulesetSchema for AzureSqlDataWarehouseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlSystemScanRulesetSchema for AzureMySqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageSystemScanRulesetSchema for AzureStorageSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataSystemScanRulesetSchema for TeradataSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleSystemScanRulesetSchema for OracleSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSystemScanRulesetSchema for SapS4HanaSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccSystemScanRulesetSchema for SapEccSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBISystemScanRulesetSchema for PowerBISystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetSystemScanRuleset with required parameters and parse the result. +", credential); + +Response response = client.GetSystemScanRuleset(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionSystemScanRulesetSchema for AzureSubscriptionSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupSystemScanRulesetSchema for AzureResourceGroupSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceSystemScanRulesetSchema for AzureSynapseWorkspaceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseSystemScanRulesetSchema for AzureSynapseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1SystemScanRulesetSchema for AdlsGen1SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2SystemScanRulesetSchema for AdlsGen2SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountSystemScanRulesetSchema for AmazonAccountSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3SystemScanRulesetSchema for AmazonS3SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlSystemScanRulesetSchema for AmazonSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbSystemScanRulesetSchema for AzureCosmosDbSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerSystemScanRulesetSchema for AzureDataExplorerSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceSystemScanRulesetSchema for AzureFileServiceSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseSystemScanRulesetSchema for AzureSqlDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlSystemScanRulesetSchema for AmazonPostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlSystemScanRulesetSchema for AzurePostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseSystemScanRulesetSchema for SqlServerDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceSystemScanRulesetSchema for AzureSqlDatabaseManagedInstanceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseSystemScanRulesetSchema for AzureSqlDataWarehouseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlSystemScanRulesetSchema for AzureMySqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageSystemScanRulesetSchema for AzureStorageSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataSystemScanRulesetSchema for TeradataSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleSystemScanRulesetSchema for OracleSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSystemScanRulesetSchema for SapS4HanaSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccSystemScanRulesetSchema for SapEccSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBISystemScanRulesetSchema for PowerBISystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetByVersionAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetByVersionAsync(1234); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetByVersionAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetByVersionAsync(1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionSystemScanRulesetSchema for AzureSubscriptionSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupSystemScanRulesetSchema for AzureResourceGroupSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceSystemScanRulesetSchema for AzureSynapseWorkspaceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseSystemScanRulesetSchema for AzureSynapseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1SystemScanRulesetSchema for AdlsGen1SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2SystemScanRulesetSchema for AdlsGen2SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountSystemScanRulesetSchema for AmazonAccountSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3SystemScanRulesetSchema for AmazonS3SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlSystemScanRulesetSchema for AmazonSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbSystemScanRulesetSchema for AzureCosmosDbSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerSystemScanRulesetSchema for AzureDataExplorerSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceSystemScanRulesetSchema for AzureFileServiceSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseSystemScanRulesetSchema for AzureSqlDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlSystemScanRulesetSchema for AmazonPostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlSystemScanRulesetSchema for AzurePostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseSystemScanRulesetSchema for SqlServerDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceSystemScanRulesetSchema for AzureSqlDatabaseManagedInstanceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseSystemScanRulesetSchema for AzureSqlDataWarehouseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlSystemScanRulesetSchema for AzureMySqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageSystemScanRulesetSchema for AzureStorageSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataSystemScanRulesetSchema for TeradataSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleSystemScanRulesetSchema for OracleSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSystemScanRulesetSchema for SapS4HanaSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccSystemScanRulesetSchema for SapEccSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBISystemScanRulesetSchema for PowerBISystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetByVersion with required parameters and parse the result. +", credential); + +Response response = client.GetByVersion(1234); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetByVersion with all parameters, and how to parse the result. +", credential); + +Response response = client.GetByVersion(1234, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionSystemScanRulesetSchema for AzureSubscriptionSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupSystemScanRulesetSchema for AzureResourceGroupSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceSystemScanRulesetSchema for AzureSynapseWorkspaceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseSystemScanRulesetSchema for AzureSynapseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1SystemScanRulesetSchema for AdlsGen1SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2SystemScanRulesetSchema for AdlsGen2SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountSystemScanRulesetSchema for AmazonAccountSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3SystemScanRulesetSchema for AmazonS3SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlSystemScanRulesetSchema for AmazonSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbSystemScanRulesetSchema for AzureCosmosDbSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerSystemScanRulesetSchema for AzureDataExplorerSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceSystemScanRulesetSchema for AzureFileServiceSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseSystemScanRulesetSchema for AzureSqlDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlSystemScanRulesetSchema for AmazonPostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlSystemScanRulesetSchema for AzurePostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseSystemScanRulesetSchema for SqlServerDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceSystemScanRulesetSchema for AzureSqlDatabaseManagedInstanceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseSystemScanRulesetSchema for AzureSqlDataWarehouseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlSystemScanRulesetSchema for AzureMySqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageSystemScanRulesetSchema for AzureStorageSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataSystemScanRulesetSchema for TeradataSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleSystemScanRulesetSchema for OracleSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSystemScanRulesetSchema for SapS4HanaSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccSystemScanRulesetSchema for SapEccSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBISystemScanRulesetSchema for PowerBISystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetLatestAsync and parse the result. +", credential); + +Response response = await client.GetLatestAsync(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetLatestAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetLatestAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionSystemScanRulesetSchema for AzureSubscriptionSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupSystemScanRulesetSchema for AzureResourceGroupSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceSystemScanRulesetSchema for AzureSynapseWorkspaceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseSystemScanRulesetSchema for AzureSynapseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1SystemScanRulesetSchema for AdlsGen1SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2SystemScanRulesetSchema for AdlsGen2SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountSystemScanRulesetSchema for AmazonAccountSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3SystemScanRulesetSchema for AmazonS3SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlSystemScanRulesetSchema for AmazonSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbSystemScanRulesetSchema for AzureCosmosDbSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerSystemScanRulesetSchema for AzureDataExplorerSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceSystemScanRulesetSchema for AzureFileServiceSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseSystemScanRulesetSchema for AzureSqlDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlSystemScanRulesetSchema for AmazonPostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlSystemScanRulesetSchema for AzurePostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseSystemScanRulesetSchema for SqlServerDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceSystemScanRulesetSchema for AzureSqlDatabaseManagedInstanceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseSystemScanRulesetSchema for AzureSqlDataWarehouseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlSystemScanRulesetSchema for AzureMySqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageSystemScanRulesetSchema for AzureStorageSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataSystemScanRulesetSchema for TeradataSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleSystemScanRulesetSchema for OracleSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSystemScanRulesetSchema for SapS4HanaSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccSystemScanRulesetSchema for SapEccSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBISystemScanRulesetSchema for PowerBISystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetLatest and parse the result. +", credential); + +Response response = client.GetLatest(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetLatest with all parameters, and how to parse the result. +", credential); + +Response response = client.GetLatest(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("kind").ToString()); +Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AzureSubscriptionSystemScanRulesetSchema for AzureSubscriptionSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
~+ 24 more JSON objects
AzureResourceGroupSystemScanRulesetSchema for AzureResourceGroupSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseWorkspaceSystemScanRulesetSchema for AzureSynapseWorkspaceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSynapseSystemScanRulesetSchema for AzureSynapseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen1SystemScanRulesetSchema for AdlsGen1SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AdlsGen2SystemScanRulesetSchema for AdlsGen2SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonAccountSystemScanRulesetSchema for AmazonAccountSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonS3SystemScanRulesetSchema for AmazonS3SystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonSqlSystemScanRulesetSchema for AmazonSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureCosmosDbSystemScanRulesetSchema for AzureCosmosDbSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureDataExplorerSystemScanRulesetSchema for AzureDataExplorerSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureFileServiceSystemScanRulesetSchema for AzureFileServiceSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseSystemScanRulesetSchema for AzureSqlDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AmazonPostgreSqlSystemScanRulesetSchema for AmazonPostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzurePostgreSqlSystemScanRulesetSchema for AzurePostgreSqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SqlServerDatabaseSystemScanRulesetSchema for SqlServerDatabaseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDatabaseManagedInstanceSystemScanRulesetSchema for AzureSqlDatabaseManagedInstanceSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureSqlDataWarehouseSystemScanRulesetSchema for AzureSqlDataWarehouseSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureMySqlSystemScanRulesetSchema for AzureMySqlSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
AzureStorageSystemScanRulesetSchema for AzureStorageSystemScanRuleset: +{ + properties: { + scanningRule: { + fileExtensions: ["AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT"], # Optional. + customFileExtensions: [ + { + customFileType: { + builtInType: "AVRO" | "ORC" | "PARQUET" | "JSON" | "TXT" | "XML" | "Documents" | "CSV" | "PSV" | "SSV" | "TSV" | "GZ" | "DOC" | "DOCM" | "DOCX" | "DOT" | "ODP" | "ODS" | "ODT" | "PDF" | "POT" | "PPS" | "PPSX" | "PPT" | "PPTM" | "PPTX" | "XLC" | "XLS" | "XLSB" | "XLSM" | "XLSX" | "XLT", # Optional. + customDelimiter: string, # Optional. + }, # Optional. + description: string, # Optional. + enabled: boolean, # Optional. + fileExtension: string, # Optional. + } + ], # Optional. + }, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
TeradataSystemScanRulesetSchema for TeradataSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
OracleSystemScanRulesetSchema for OracleSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapS4HanaSystemScanRulesetSchema for SapS4HanaSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
SapEccSystemScanRulesetSchema for SapEccSystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
PowerBISystemScanRulesetSchema for PowerBISystemScanRuleset: +{ + properties: { + createdAt: string (ISO 8601 Format), # Optional. + description: string, # Optional. + excludedSystemClassifications: [string], # Optional. + includedCustomClassificationRuleNames: [string], # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + }, # Optional. + kind: None, # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + +
+
+ + + + + +This sample shows how to call GetSystemScanRulesetsAsync and parse the result. +", credential); + +await foreach (var data in client.GetSystemScanRulesetsAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SystemScanRulesetListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetSystemScanRulesets and parse the result. +", credential); + +foreach (var data in client.GetSystemScanRulesets()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SystemScanRulesetListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetVersionsByDataSourceAsync and parse the result. +", credential); + +await foreach (var data in client.GetVersionsByDataSourceAsync()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetVersionsByDataSourceAsync with all parameters, and how to parse the result. +", credential); + +await foreach (var data in client.GetVersionsByDataSourceAsync("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SystemScanRulesetListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetVersionsByDataSource and parse the result. +", credential); + +foreach (var data in client.GetVersionsByDataSource()) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.ToString()); +} +]]> +This sample shows how to call GetVersionsByDataSource with all parameters, and how to parse the result. +", credential); + +foreach (var data in client.GetVersionsByDataSource("")) +{ + JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("kind").ToString()); + Console.WriteLine(result.GetProperty("scanRulesetType").ToString()); + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("version").ToString()); + Console.WriteLine(result.GetProperty("id").ToString()); + Console.WriteLine(result.GetProperty("name").ToString()); +} +]]> + + +Below is the JSON schema for one item in the pageable response. + +Response Body: + +Schema for SystemScanRulesetListValue: +{ + kind: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI", # Required. + scanRulesetType: "Custom" | "System", # Optional. + status: "Enabled" | "Disabled", # Optional. + version: number, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/TriggersClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/TriggersClient.xml new file mode 100644 index 000000000000..3ba1f2427226 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/TriggersClient.xml @@ -0,0 +1,643 @@ + + + + + +This sample shows how to call GetTriggerAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetTriggerAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("frequency").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("interval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("minutes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("hours")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("weekDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("day").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("occurrence").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrenceInterval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastModifiedAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastScheduled").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("scanLevel").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("incrementalScanStartTime").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call GetTrigger with required parameters and parse the result. +", credential); + +Response response = client.GetTrigger("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("frequency").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("interval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("minutes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("hours")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("weekDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("day").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("occurrence").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrenceInterval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastModifiedAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastScheduled").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("scanLevel").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("incrementalScanStartTime").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call CreateTriggerAsync with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateTriggerAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateTriggerAsync with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + recurrence = new { + frequency = "Week", + interval = 1234, + startTime = "2022-05-10T18:57:31.2311892Z", + endTime = "2022-05-10T18:57:31.2311892Z", + schedule = new { + additionalProperties = new { + key = new {}, + }, + minutes = new[] { + 1234 + }, + hours = new[] { + 1234 + }, + weekDays = new[] { + "Sunday" + }, + monthDays = new[] { + 1234 + }, + monthlyOccurrences = new[] { + new { + additionalProperties = new { + key = new {}, + }, + day = "Sunday", + occurrence = 1234, + } + }, + }, + timeZone = "", + }, + recurrenceInterval = "", + scanLevel = "Full", + incrementalScanStartTime = "2022-05-10T18:57:31.2311892Z", + }, +}; + +Response response = await client.CreateTriggerAsync("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("frequency").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("interval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("minutes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("hours")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("weekDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("day").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("occurrence").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrenceInterval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastModifiedAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastScheduled").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("scanLevel").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("incrementalScanStartTime").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + +Response Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call CreateTrigger with required parameters and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateTrigger("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateTrigger with all parameters and request content, and how to parse the result. +", credential); + +var data = new { + properties = new { + recurrence = new { + frequency = "Week", + interval = 1234, + startTime = "2022-05-10T18:57:31.2311892Z", + endTime = "2022-05-10T18:57:31.2311892Z", + schedule = new { + additionalProperties = new { + key = new {}, + }, + minutes = new[] { + 1234 + }, + hours = new[] { + 1234 + }, + weekDays = new[] { + "Sunday" + }, + monthDays = new[] { + 1234 + }, + monthlyOccurrences = new[] { + new { + additionalProperties = new { + key = new {}, + }, + day = "Sunday", + occurrence = 1234, + } + }, + }, + timeZone = "", + }, + recurrenceInterval = "", + scanLevel = "Full", + incrementalScanStartTime = "2022-05-10T18:57:31.2311892Z", + }, +}; + +Response response = client.CreateTrigger("", "", RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("frequency").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("interval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("minutes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("hours")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("weekDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("day").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("occurrence").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrenceInterval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastModifiedAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastScheduled").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("scanLevel").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("incrementalScanStartTime").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + +Response Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call DeleteTriggerAsync with required parameters and parse the result. +", credential); + +Response response = await client.DeleteTriggerAsync("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("frequency").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("interval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("minutes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("hours")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("weekDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("day").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("occurrence").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrenceInterval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastModifiedAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastScheduled").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("scanLevel").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("incrementalScanStartTime").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + +This sample shows how to call DeleteTrigger with required parameters and parse the result. +", credential); + +Response response = client.DeleteTrigger("", ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("frequency").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("interval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("startTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("endTime").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("minutes")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("hours")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("weekDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthDays")[0].ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("additionalProperties").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("day").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("schedule").GetProperty("monthlyOccurrences")[0].GetProperty("occurrence").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrence").GetProperty("timeZone").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("recurrenceInterval").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("createdAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastModifiedAt").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("lastScheduled").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("scanLevel").ToString()); +Console.WriteLine(result.GetProperty("properties").GetProperty("incrementalScanStartTime").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for Trigger: +{ + properties: { + recurrence: { + frequency: "Week" | "Month", # Optional. + interval: number, # Optional. + startTime: string (ISO 8601 Format), # Optional. + endTime: string (ISO 8601 Format), # Optional. + schedule: { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + minutes: [number], # Optional. + hours: [number], # Optional. + weekDays: ["Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"], # Optional. + monthDays: [number], # Optional. + monthlyOccurrences: [ + { + additionalProperties: Dictionary<string, AnyObject>, # Optional. Dictionary of <AnyObject> + day: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday", # Optional. + occurrence: number, # Optional. + } + ], # Optional. + }, # Optional. + timeZone: string, # Optional. + }, # Optional. + recurrenceInterval: string, # Optional. + createdAt: string (ISO 8601 Format), # Optional. + lastModifiedAt: string (ISO 8601 Format), # Optional. + lastScheduled: string (ISO 8601 Format), # Optional. + scanLevel: "Full" | "Incremental", # Optional. + incrementalScanStartTime: string (ISO 8601 Format), # Optional. + }, # Optional. + id: string, # Optional. + name: string, # Optional. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/TypesClient.xml b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/TypesClient.xml new file mode 100644 index 000000000000..b6e10e2da50a --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/Docs/TypesClient.xml @@ -0,0 +1,14697 @@ + + + + + +This sample shows how to call GetBusinessMetadataDefByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetBusinessMetadataDefByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetBusinessMetadataDefByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetBusinessMetadataDefByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetBusinessMetadataDefByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetBusinessMetadataDefByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetBusinessMetadataDefByName with required parameters and parse the result. +", credential); + +Response response = client.GetBusinessMetadataDefByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetClassificationDefByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetClassificationDefByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetClassificationDefByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetClassificationDefByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetClassificationDefByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetClassificationDefByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetClassificationDefByName with required parameters and parse the result. +", credential); + +Response response = client.GetClassificationDefByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEntityDefinitionByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetEntityDefinitionByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEntityDefinitionByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetEntityDefinitionByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEntityDefinitionByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetEntityDefinitionByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEntityDefinitionByName with required parameters and parse the result. +", credential); + +Response response = client.GetEntityDefinitionByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEnumDefByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetEnumDefByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEnumDef: +{ + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEnumDefByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetEnumDefByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEnumDef: +{ + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEnumDefByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetEnumDefByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEnumDef: +{ + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetEnumDefByName with required parameters and parse the result. +", credential); + +Response response = client.GetEnumDefByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasEnumDef: +{ + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetRelationshipDefByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetRelationshipDefByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetRelationshipDefByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetRelationshipDefByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetRelationshipDefByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetRelationshipDefByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetRelationshipDefByName with required parameters and parse the result. +", credential); + +Response response = client.GetRelationshipDefByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetStructDefByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetStructDefByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AtlasBusinessMetadataDefSchema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
~+ 4 more JSON objects
AtlasClassificationDefSchema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasEntityDefSchema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasRelationshipDefSchema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
TermTemplateDefSchema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
+ + + + + +This sample shows how to call GetStructDefByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetStructDefByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AtlasBusinessMetadataDefSchema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
~+ 4 more JSON objects
AtlasClassificationDefSchema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasEntityDefSchema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasRelationshipDefSchema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
TermTemplateDefSchema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
+ + + + + +This sample shows how to call GetStructDefByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetStructDefByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AtlasBusinessMetadataDefSchema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
~+ 4 more JSON objects
AtlasClassificationDefSchema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasEntityDefSchema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasRelationshipDefSchema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
TermTemplateDefSchema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
+ + + + + +This sample shows how to call GetStructDefByName with required parameters and parse the result. +", credential); + +Response response = client.GetStructDefByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +This method takes one of the JSON objects below as a payload. Please select a JSON object to view the schema for this. +
AtlasBusinessMetadataDefSchema for AtlasBusinessMetadataDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
~+ 4 more JSON objects
AtlasClassificationDefSchema for AtlasClassificationDef: +{ + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasEntityDefSchema for AtlasEntityDef: +{ + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
AtlasRelationshipDefSchema for AtlasRelationshipDef: +{ + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
TermTemplateDefSchema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + +
+
+ + + + + +This sample shows how to call GetTypeDefinitionByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetTypeDefinitionByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypeDef: +{ + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetTypeDefinitionByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetTypeDefinitionByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypeDef: +{ + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetTypeDefinitionByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetTypeDefinitionByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypeDef: +{ + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetTypeDefinitionByName with required parameters and parse the result. +", credential); + +Response response = client.GetTypeDefinitionByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypeDef: +{ + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call DeleteTypeByNameAsync with required parameters. +", credential); + +Response response = await client.DeleteTypeByNameAsync(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call DeleteTypeByName with required parameters. +", credential); + +Response response = client.DeleteTypeByName(""); +Console.WriteLine(response.Status); +]]> + + + + +This sample shows how to call GetAllTypeDefinitionsAsync and parse the result. +", credential); + +Response response = await client.GetAllTypeDefinitionsAsync(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetAllTypeDefinitionsAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetAllTypeDefinitionsAsync(true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call GetAllTypeDefinitions and parse the result. +", credential); + +Response response = client.GetAllTypeDefinitions(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call GetAllTypeDefinitions with all parameters, and how to parse the result. +", credential); + +Response response = client.GetAllTypeDefinitions(true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call CreateTypeDefinitionsAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.CreateTypeDefinitionsAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateTypeDefinitionsAsync with all request content, and how to parse the result. +", credential); + +var data = new { + businessMetadataDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + classificationDefs = new[] { + new { + entityTypes = new[] { + "" + }, + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + entityDefs = new[] { + new { + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + relationshipAttributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + enumDefs = new[] { + new { + defaultValue = "", + elementDefs = new[] { + new { + description = "", + ordinal = 123.45f, + value = "", + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + relationshipDefs = new[] { + new { + endDef1 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + endDef2 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + relationshipCategory = "ASSOCIATION", + relationshipLabel = "", + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + structDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + termTemplateDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, +}; + +Response response = await client.CreateTypeDefinitionsAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + +Response Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call CreateTypeDefinitions and parse the result. +", credential); + +var data = new {}; + +Response response = client.CreateTypeDefinitions(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call CreateTypeDefinitions with all request content, and how to parse the result. +", credential); + +var data = new { + businessMetadataDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + classificationDefs = new[] { + new { + entityTypes = new[] { + "" + }, + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + entityDefs = new[] { + new { + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + relationshipAttributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + enumDefs = new[] { + new { + defaultValue = "", + elementDefs = new[] { + new { + description = "", + ordinal = 123.45f, + value = "", + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + relationshipDefs = new[] { + new { + endDef1 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + endDef2 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + relationshipCategory = "ASSOCIATION", + relationshipLabel = "", + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + structDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + termTemplateDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, +}; + +Response response = client.CreateTypeDefinitions(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + +Response Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call UpdateAtlasTypeDefinitionsAsync and parse the result. +", credential); + +var data = new {}; + +Response response = await client.UpdateAtlasTypeDefinitionsAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateAtlasTypeDefinitionsAsync with all request content, and how to parse the result. +", credential); + +var data = new { + businessMetadataDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + classificationDefs = new[] { + new { + entityTypes = new[] { + "" + }, + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + entityDefs = new[] { + new { + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + relationshipAttributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + enumDefs = new[] { + new { + defaultValue = "", + elementDefs = new[] { + new { + description = "", + ordinal = 123.45f, + value = "", + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + relationshipDefs = new[] { + new { + endDef1 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + endDef2 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + relationshipCategory = "ASSOCIATION", + relationshipLabel = "", + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + structDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + termTemplateDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, +}; + +Response response = await client.UpdateAtlasTypeDefinitionsAsync(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + +Response Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call UpdateAtlasTypeDefinitions and parse the result. +", credential); + +var data = new {}; + +Response response = client.UpdateAtlasTypeDefinitions(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> +This sample shows how to call UpdateAtlasTypeDefinitions with all request content, and how to parse the result. +", credential); + +var data = new { + businessMetadataDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + classificationDefs = new[] { + new { + entityTypes = new[] { + "" + }, + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + entityDefs = new[] { + new { + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + relationshipAttributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + enumDefs = new[] { + new { + defaultValue = "", + elementDefs = new[] { + new { + description = "", + ordinal = 123.45f, + value = "", + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + relationshipDefs = new[] { + new { + endDef1 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + endDef2 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + relationshipCategory = "ASSOCIATION", + relationshipLabel = "", + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + structDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + termTemplateDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, +}; + +Response response = client.UpdateAtlasTypeDefinitions(RequestContent.Create(data)); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("businessMetadataDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("entityTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("classificationDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("subTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("superTypes")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("relationshipTypeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("relationshipAttributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("entityDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("ordinal").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("elementDefs")[0].GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("enumDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef1").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isContainer").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("isLegacyAttribute").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("endDef2").GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipCategory").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("relationshipLabel").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("relationshipDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("structDefs")[0].GetProperty("lastModifiedTS").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("termTemplateDefs")[0].GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the request and response payloads. + +Request Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + +Response Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call DeleteTypeDefinitionsAsync. +", credential); + +var data = new {}; + +Response response = await client.DeleteTypeDefinitionsAsync(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call DeleteTypeDefinitionsAsync with all request content. +", credential); + +var data = new { + businessMetadataDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + classificationDefs = new[] { + new { + entityTypes = new[] { + "" + }, + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + entityDefs = new[] { + new { + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + relationshipAttributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + enumDefs = new[] { + new { + defaultValue = "", + elementDefs = new[] { + new { + description = "", + ordinal = 123.45f, + value = "", + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + relationshipDefs = new[] { + new { + endDef1 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + endDef2 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + relationshipCategory = "ASSOCIATION", + relationshipLabel = "", + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + structDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + termTemplateDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, +}; + +Response response = await client.DeleteTypeDefinitionsAsync(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call DeleteTypeDefinitions. +", credential); + +var data = new {}; + +Response response = client.DeleteTypeDefinitions(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> +This sample shows how to call DeleteTypeDefinitions with all request content. +", credential); + +var data = new { + businessMetadataDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + classificationDefs = new[] { + new { + entityTypes = new[] { + "" + }, + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + entityDefs = new[] { + new { + subTypes = new[] { + "" + }, + superTypes = new[] { + "" + }, + relationshipAttributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + enumDefs = new[] { + new { + defaultValue = "", + elementDefs = new[] { + new { + description = "", + ordinal = 123.45f, + value = "", + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + relationshipDefs = new[] { + new { + endDef1 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + endDef2 = new { + cardinality = "SINGLE", + description = "", + isContainer = true, + isLegacyAttribute = true, + name = "", + type = "", + }, + relationshipCategory = "ASSOCIATION", + relationshipLabel = "", + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + structDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, + termTemplateDefs = new[] { + new { + attributeDefs = new[] { + new { + isLegacyAttribute = true, + relationshipTypeName = "", + cardinality = "SINGLE", + constraints = new[] { + new { + params = new { + key = new {}, + }, + type = "", + } + }, + defaultValue = "", + description = "", + includeInNotification = true, + isIndexable = true, + isOptional = true, + isUnique = true, + name = "", + options = new { + key = "", + }, + typeName = "", + valuesMaxCount = 1234, + valuesMinCount = 1234, + } + }, + category = "PRIMITIVE", + createTime = 123.45f, + createdBy = "", + dateFormatter = new { + availableLocales = new[] { + "" + }, + calendar = 123.45f, + lenient = true, + numberFormat = new { + availableLocales = new[] { + "" + }, + currency = "", + groupingUsed = true, + maximumFractionDigits = 1234, + maximumIntegerDigits = 1234, + minimumFractionDigits = 1234, + minimumIntegerDigits = 1234, + parseIntegerOnly = true, + roundingMode = "UP", + }, + timeZone = new { + dstSavings = 1234, + id = "", + availableIds = new[] { + "" + }, + displayName = "", + rawOffset = 1234, + }, + }, + description = "", + guid = "", + name = "", + options = new { + key = "", + }, + serviceType = "", + typeVersion = "", + updateTime = 123.45f, + updatedBy = "", + version = 123.45f, + lastModifiedTS = "", + } + }, +}; + +Response response = client.DeleteTypeDefinitions(RequestContent.Create(data)); +Console.WriteLine(response.Status); +]]> + + +Below is the JSON schema for the request payload. + +Request Body: + +Schema for AtlasTypesDef: +{ + businessMetadataDefs: [ + { + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. businessMetadataDefs + classificationDefs: [ + { + entityTypes: [string], # Optional. Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul> + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of classification definitions. + entityDefs: [ + { + subTypes: [string], # Optional. An array of sub types. + superTypes: [string], # Optional. An array of super types. + relationshipAttributeDefs: [ + { + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + relationshipTypeName: string, # Optional. The name of the relationship type. + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [AtlasConstraintDef], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of relationship attributes. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of entity definitions. + enumDefs: [ + { + defaultValue: string, # Optional. The default value. + elementDefs: [ + { + description: string, # Optional. The description of the enum element definition. + ordinal: number, # Optional. The ordinal of the enum element definition. + value: string, # Optional. The value of the enum element definition. + } + ], # Optional. An array of enum element definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of enum definitions. + relationshipDefs: [ + { + endDef1: { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + description: string, # Optional. The description of the relationship end definition. + isContainer: boolean, # Optional. Determines if it is container. + isLegacyAttribute: boolean, # Optional. Determines if it is a legacy attribute. + name: string, # Optional. The name of the relationship end definition. + type: string, # Optional. The type of the relationship end. + }, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + endDef2: AtlasRelationshipEndDef, # Optional. The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship. + relationshipCategory: "ASSOCIATION" | "AGGREGATION" | "COMPOSITION", # Optional. The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independent. + relationshipLabel: string, # Optional. The label of the relationship. + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of relationship definitions. + structDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of struct definitions. + termTemplateDefs: [ + { + attributeDefs: [AtlasAttributeDef], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: DateFormat, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. + } + ], # Optional. An array of term template definitions. +} + + + + + + +This sample shows how to call GetTypeDefinitionHeadersAsync and parse the result. +", credential); + +Response response = await client.GetTypeDefinitionHeadersAsync(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetTypeDefinitionHeadersAsync with all parameters, and how to parse the result. +", credential); + +Response response = await client.GetTypeDefinitionHeadersAsync(true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("category").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypeDefHeader: +{ + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. +} + + + + + + +This sample shows how to call GetTypeDefinitionHeaders and parse the result. +", credential); + +Response response = client.GetTypeDefinitionHeaders(); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].ToString()); +]]> +This sample shows how to call GetTypeDefinitionHeaders with all parameters, and how to parse the result. +", credential); + +Response response = client.GetTypeDefinitionHeaders(true, ""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result[0].GetProperty("category").ToString()); +Console.WriteLine(result[0].GetProperty("guid").ToString()); +Console.WriteLine(result[0].GetProperty("name").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for AtlasTypeDefHeader: +{ + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. +} + + + + + + +This sample shows how to call GetTermTemplateDefByGuidAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetTermTemplateDefByGuidAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetTermTemplateDefByGuid with required parameters and parse the result. +", credential); + +Response response = client.GetTermTemplateDefByGuid(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetTermTemplateDefByNameAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetTermTemplateDefByNameAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + +This sample shows how to call GetTermTemplateDefByName with required parameters and parse the result. +", credential); + +Response response = client.GetTermTemplateDefByName(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("cardinality").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("params").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("constraints")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("defaultValue").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("includeInNotification").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isIndexable").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isOptional").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("isUnique").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("typeName").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMaxCount").ToString()); +Console.WriteLine(result.GetProperty("attributeDefs")[0].GetProperty("valuesMinCount").ToString()); +Console.WriteLine(result.GetProperty("category").ToString()); +Console.WriteLine(result.GetProperty("createTime").ToString()); +Console.WriteLine(result.GetProperty("createdBy").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("calendar").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("lenient").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("availableLocales")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("currency").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("groupingUsed").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("maximumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumFractionDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("minimumIntegerDigits").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("parseIntegerOnly").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("numberFormat").GetProperty("roundingMode").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("dstSavings").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("availableIds")[0].ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("displayName").ToString()); +Console.WriteLine(result.GetProperty("dateFormatter").GetProperty("timeZone").GetProperty("rawOffset").ToString()); +Console.WriteLine(result.GetProperty("description").ToString()); +Console.WriteLine(result.GetProperty("guid").ToString()); +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("options").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("serviceType").ToString()); +Console.WriteLine(result.GetProperty("typeVersion").ToString()); +Console.WriteLine(result.GetProperty("updateTime").ToString()); +Console.WriteLine(result.GetProperty("updatedBy").ToString()); +Console.WriteLine(result.GetProperty("version").ToString()); +Console.WriteLine(result.GetProperty("lastModifiedTS").ToString()); +]]> + + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for TermTemplateDef: +{ + attributeDefs: [ + { + cardinality: "SINGLE" | "LIST" | "SET", # Optional. single-valued attribute or multi-valued attribute. + constraints: [ + { + params: Dictionary<string, AnyObject>, # Optional. The parameters of the constraint definition. + type: string, # Optional. The type of the constraint. + } + ], # Optional. An array of constraints. + defaultValue: string, # Optional. The default value of the attribute. + description: string, # Optional. The description of the attribute. + includeInNotification: boolean, # Optional. Determines if it is included in notification. + isIndexable: boolean, # Optional. Determines if it is indexable. + isOptional: boolean, # Optional. Determines if it is optional. + isUnique: boolean, # Optional. Determines if it unique. + name: string, # Optional. The name of the attribute. + options: Dictionary<string, string>, # Optional. The options for the attribute. + typeName: string, # Optional. The name of the type. + valuesMaxCount: number, # Optional. The maximum count of the values. + valuesMinCount: number, # Optional. The minimum count of the values. + } + ], # Optional. An array of attribute definitions. + category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE", # Optional. The enum of type category. + createTime: number, # Optional. The created time of the record. + createdBy: string, # Optional. The user who created the record. + dateFormatter: { + availableLocales: [string], # Optional. An array of available locales. + calendar: number, # Optional. + dateInstance: DateFormat, # Optional. The date format. + dateTimeInstance: DateFormat, # Optional. The date format. + instance: DateFormat, # Optional. The date format. + lenient: boolean, # Optional. Determines the leniency of the date format. + numberFormat: { + availableLocales: [string], # Optional. The number format. + currency: string, # Optional. The currency. + currencyInstance: NumberFormat, # Optional. The number format. + groupingUsed: boolean, # Optional. Determines if grouping is used. + instance: NumberFormat, # Optional. The number format. + integerInstance: NumberFormat, # Optional. The number format. + maximumFractionDigits: number, # Optional. The maximum of fraction digits. + maximumIntegerDigits: number, # Optional. The maximum of integer digits. + minimumFractionDigits: number, # Optional. The minimum of fraction digits. + minimumIntegerDigits: number, # Optional. The minimum of integer digits. + numberInstance: NumberFormat, # Optional. The number format. + parseIntegerOnly: boolean, # Optional. Determines if only integer is parsed. + percentInstance: NumberFormat, # Optional. The number format. + roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY", # Optional. The enum of rounding mode. + }, # Optional. The number format. + timeInstance: DateFormat, # Optional. The date format. + timeZone: { + dstSavings: number, # Optional. The value of the daylight saving time. + id: string, # Optional. The ID of the timezone. + availableIds: [string], # Optional. An array of available IDs. + default: TimeZone, # Optional. The timezone information. + displayName: string, # Optional. The display name of the timezone. + rawOffset: number, # Optional. The raw offset of the timezone. + }, # Optional. The timezone information. + }, # Optional. The date format. + description: string, # Optional. The description of the type definition. + guid: string, # Optional. The GUID of the type definition. + name: string, # Optional. The name of the type definition. + options: Dictionary<string, string>, # Optional. The options for the type definition. + serviceType: string, # Optional. The service type. + typeVersion: string, # Optional. The version of the type. + updateTime: number, # Optional. The update time of the record. + updatedBy: string, # Optional. The user who updated the record. + version: number, # Optional. The version of the record. + lastModifiedTS: string, # Optional. ETag for concurrency control. +} + + + + + + \ No newline at end of file diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/EmailRegistrationClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/EmailRegistrationClient.cs new file mode 100644 index 000000000000..aa04763280ec --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/EmailRegistrationClient.cs @@ -0,0 +1,198 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The EmailRegistration service client. + /// The EmailRegistration service client. + public partial class EmailRegistrationClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of EmailRegistrationClient for mocking. + protected EmailRegistrationClient() + { + } + + /// Initializes a new instance of EmailRegistrationClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public EmailRegistrationClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of EmailRegistrationClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public EmailRegistrationClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Activates the tenant and email combination using the activation code received. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task ActivateAsync(RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EmailRegistrationClient.Activate"); + scope.Start(); + try + { + using HttpMessage message = CreateActivateRequest(content, repeatabilityRequestId, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Activates the tenant and email combination using the activation code received. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Activate(RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EmailRegistrationClient.Activate"); + scope.Start(); + try + { + using HttpMessage message = CreateActivateRequest(content, repeatabilityRequestId, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Registers the tenant and email combination for activation. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task RegisterAsync(string repeatabilityRequestId = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("EmailRegistrationClient.Register"); + scope.Start(); + try + { + using HttpMessage message = CreateRegisterRequest(repeatabilityRequestId, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Registers the tenant and email combination for activation. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Register(string repeatabilityRequestId = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("EmailRegistrationClient.Register"); + scope.Start(); + try + { + using HttpMessage message = CreateRegisterRequest(repeatabilityRequestId, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateActivateRequest(RequestContent content, string repeatabilityRequestId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/activateEmail", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + if (repeatabilityRequestId != null) + { + request.Headers.Add("repeatability-request-id", repeatabilityRequestId); + } + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateRegisterRequest(string repeatabilityRequestId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/registerEmail", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + if (repeatabilityRequestId != null) + { + request.Headers.Add("repeatability-request-id", repeatabilityRequestId); + } + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/EntityClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/EntityClient.cs new file mode 100644 index 000000000000..308586d85964 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/EntityClient.cs @@ -0,0 +1,2659 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Entity service client. + /// The Entity service client. + public partial class EntityClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of EntityClient for mocking. + protected EntityClient() + { + } + + /// Initializes a new instance of EntityClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public EntityClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of EntityClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public EntityClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// + /// Create or update an entity in Atlas. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Create or update an entity in Atlas. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List entities in bulk identified by its GUIDs. + /// An array of GUIDs of entities to list. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// An array of the relationship types need to be excluded from the response. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetEntitiesByGuidsAsync(IEnumerable guids, bool? minExtInfo = null, bool? ignoreRelationships = null, IEnumerable excludeRelationshipTypes = null, RequestContext context = null) + { + Argument.AssertNotNull(guids, nameof(guids)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetEntitiesByGuids"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntitiesByGuidsRequest(guids, minExtInfo, ignoreRelationships, excludeRelationshipTypes, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List entities in bulk identified by its GUIDs. + /// An array of GUIDs of entities to list. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// An array of the relationship types need to be excluded from the response. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetEntitiesByGuids(IEnumerable guids, bool? minExtInfo = null, bool? ignoreRelationships = null, IEnumerable excludeRelationshipTypes = null, RequestContext context = null) + { + Argument.AssertNotNull(guids, nameof(guids)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetEntitiesByGuids"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntitiesByGuidsRequest(guids, minExtInfo, ignoreRelationships, excludeRelationshipTypes, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Create or update entities in Atlas in bulk. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateEntitiesAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.CreateOrUpdateEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateEntitiesRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Create or update entities in Atlas in bulk. + /// Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. + /// Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. + /// + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdateEntities(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.CreateOrUpdateEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateEntitiesRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a list of entities in bulk identified by their GUIDs or unique attributes. + /// An array of GUIDs of entities to delete. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteByGuidsAsync(IEnumerable guids, RequestContext context = null) + { + Argument.AssertNotNull(guids, nameof(guids)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteByGuids"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteByGuidsRequest(guids, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a list of entities in bulk identified by their GUIDs or unique attributes. + /// An array of GUIDs of entities to delete. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response DeleteByGuids(IEnumerable guids, RequestContext context = null) + { + Argument.AssertNotNull(guids, nameof(guids)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteByGuids"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteByGuidsRequest(guids, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Associate a classification to multiple entities in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AddClassificationAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddClassification"); + scope.Start(); + try + { + using HttpMessage message = CreateAddClassificationRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Associate a classification to multiple entities in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AddClassification(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddClassification"); + scope.Start(); + try + { + using HttpMessage message = CreateAddClassificationRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get complete definition of an entity given its GUID. + /// The globally unique identifier of the entity. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetByGuidAsync(string guid, bool? minExtInfo = null, bool? ignoreRelationships = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetByGuidRequest(guid, minExtInfo, ignoreRelationships, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get complete definition of an entity given its GUID. + /// The globally unique identifier of the entity. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetByGuid(string guid, bool? minExtInfo = null, bool? ignoreRelationships = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetByGuidRequest(guid, minExtInfo, ignoreRelationships, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Update entity partially - create or update entity attribute identified by its GUID. + /// Supports only primitive attribute type and entity references. + /// It does not support updating complex types like arrays, and maps. + /// Null updates are not possible. + /// + /// The globally unique identifier of the entity. + /// The name of the attribute. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task PartialUpdateEntityAttributeByGuidAsync(string guid, string name, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.PartialUpdateEntityAttributeByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateEntityAttributeByGuidRequest(guid, name, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Update entity partially - create or update entity attribute identified by its GUID. + /// Supports only primitive attribute type and entity references. + /// It does not support updating complex types like arrays, and maps. + /// Null updates are not possible. + /// + /// The globally unique identifier of the entity. + /// The name of the attribute. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response PartialUpdateEntityAttributeByGuid(string guid, string name, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.PartialUpdateEntityAttributeByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateEntityAttributeByGuidRequest(guid, name, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete an entity identified by its GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete an entity identified by its GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response DeleteByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List classifications for a given entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The name of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetClassificationAsync(string guid, string classificationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(classificationName, nameof(classificationName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetClassification"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationRequest(guid, classificationName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List classifications for a given entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The name of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetClassification(string guid, string classificationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(classificationName, nameof(classificationName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetClassification"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationRequest(guid, classificationName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a given classification from an existing entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The name of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteClassificationAsync(string guid, string classificationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(classificationName, nameof(classificationName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteClassification"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteClassificationRequest(guid, classificationName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a given classification from an existing entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The name of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteClassification(string guid, string classificationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(classificationName, nameof(classificationName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteClassification"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteClassificationRequest(guid, classificationName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List classifications for a given entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetClassificationsAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationsRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List classifications for a given entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetClassifications(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationsRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add classifications to an existing entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AddClassificationsAsync(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateAddClassificationsRequest(guid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add classifications to an existing entity represented by a GUID. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AddClassifications(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateAddClassificationsRequest(guid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update classifications to an existing entity represented by a guid. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task UpdateClassificationsAsync(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.UpdateClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateClassificationsRequest(guid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update classifications to an existing entity represented by a guid. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response UpdateClassifications(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.UpdateClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateClassificationsRequest(guid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Get complete definition of an entity given its type and unique attribute. + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: + /// attr:\<attrName>=<attrValue>. + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + /// The REST request would look something like this: + /// GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// + /// The name of the type. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetByUniqueAttributesAsync(string typeName, bool? minExtInfo = null, bool? ignoreRelationships = null, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetByUniqueAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateGetByUniqueAttributesRequest(typeName, minExtInfo, ignoreRelationships, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Get complete definition of an entity given its type and unique attribute. + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: + /// attr:\<attrName>=<attrValue>. + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + /// The REST request would look something like this: + /// GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// + /// The name of the type. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetByUniqueAttributes(string typeName, bool? minExtInfo = null, bool? ignoreRelationships = null, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetByUniqueAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateGetByUniqueAttributesRequest(typeName, minExtInfo, ignoreRelationships, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Update entity partially - Allow a subset of attributes to be updated on + /// an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. + /// Null updates are not possible. + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: + /// attr:<attrName>=<attrValue>. + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + /// The REST request would look something like this: + /// PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task PartialUpdateEntityByUniqueAttributesAsync(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.PartialUpdateEntityByUniqueAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateEntityByUniqueAttributesRequest(typeName, content, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Update entity partially - Allow a subset of attributes to be updated on + /// an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. + /// Null updates are not possible. + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: + /// attr:<attrName>=<attrValue>. + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + /// The REST request would look something like this: + /// PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response PartialUpdateEntityByUniqueAttributes(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.PartialUpdateEntityByUniqueAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateEntityByUniqueAttributesRequest(typeName, content, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Delete an entity identified by its type and unique attributes. + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: + /// attr:\<attrName>=\<attrValue>. + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + /// The REST request would look something like this: + /// DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// + /// The name of the type. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteByUniqueAttributeAsync(string typeName, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteByUniqueAttributeRequest(typeName, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Delete an entity identified by its type and unique attributes. + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: + /// attr:\<attrName>=\<attrValue>. + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + /// The REST request would look something like this: + /// DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// + /// The name of the type. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response DeleteByUniqueAttribute(string typeName, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteByUniqueAttributeRequest(typeName, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a given classification from an entity identified by its type and unique attributes. + /// The name of the type. + /// The name of the classification. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteClassificationByUniqueAttributeAsync(string typeName, string classificationName, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNullOrEmpty(classificationName, nameof(classificationName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteClassificationByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteClassificationByUniqueAttributeRequest(typeName, classificationName, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a given classification from an entity identified by its type and unique attributes. + /// The name of the type. + /// The name of the classification. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteClassificationByUniqueAttribute(string typeName, string classificationName, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNullOrEmpty(classificationName, nameof(classificationName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteClassificationByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteClassificationByUniqueAttributeRequest(typeName, classificationName, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add classification to the entity identified by its type and unique attributes. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AddClassificationsByUniqueAttributeAsync(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddClassificationsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateAddClassificationsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add classification to the entity identified by its type and unique attributes. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AddClassificationsByUniqueAttribute(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddClassificationsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateAddClassificationsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update classification on an entity identified by its type and unique attributes. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task UpdateClassificationsByUniqueAttributeAsync(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.UpdateClassificationsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateClassificationsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update classification on an entity identified by its type and unique attributes. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response UpdateClassificationsByUniqueAttribute(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.UpdateClassificationsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateClassificationsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Set classifications on entities in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task SetClassificationsAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.SetClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateSetClassificationsRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Set classifications on entities in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response SetClassifications(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.SetClassifications"); + scope.Start(); + try + { + using HttpMessage message = CreateSetClassificationsRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Bulk API to retrieve list of entities identified by its unique attributes. + /// + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format + /// + /// typeName=\<typeName>&attr_1:\<attrName>=\<attrValue>&attr_2:\<attrName>=\<attrValue>&attr_3:\<attrName>=\<attrValue> + /// + /// NOTE: The attrName should be an unique attribute for the given entity-type + /// + /// The REST request would look something like this + /// + /// GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + /// + /// The name of the type. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// Qualified name of an entity. E.g. to find 2 entities you can set attrs_0:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetEntitiesByUniqueAttributesAsync(string typeName, bool? minExtInfo = null, bool? ignoreRelationships = null, string attrNQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetEntitiesByUniqueAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntitiesByUniqueAttributesRequest(typeName, minExtInfo, ignoreRelationships, attrNQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Bulk API to retrieve list of entities identified by its unique attributes. + /// + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format + /// + /// typeName=\<typeName>&attr_1:\<attrName>=\<attrValue>&attr_2:\<attrName>=\<attrValue>&attr_3:\<attrName>=\<attrValue> + /// + /// NOTE: The attrName should be an unique attribute for the given entity-type + /// + /// The REST request would look something like this + /// + /// GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + /// + /// The name of the type. + /// Whether to return minimal information for referred entities. + /// Whether to ignore relationship attributes. + /// Qualified name of an entity. E.g. to find 2 entities you can set attrs_0:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetEntitiesByUniqueAttributes(string typeName, bool? minExtInfo = null, bool? ignoreRelationships = null, string attrNQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetEntitiesByUniqueAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntitiesByUniqueAttributesRequest(typeName, minExtInfo, ignoreRelationships, attrNQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get entity header given its GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetHeaderAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetHeader"); + scope.Start(); + try + { + using HttpMessage message = CreateGetHeaderRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get entity header given its GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetHeader(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetHeader"); + scope.Start(); + try + { + using HttpMessage message = CreateGetHeaderRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Remove business metadata from an entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteBusinessMetadataAsync(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteBusinessMetadata"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteBusinessMetadataRequest(guid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Remove business metadata from an entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteBusinessMetadata(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteBusinessMetadata"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteBusinessMetadataRequest(guid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add business metadata to an entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether to overwrite the existing business metadata on the entity or not, default is false. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AddOrUpdateBusinessMetadataAsync(string guid, RequestContent content, bool? isOverwrite = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddOrUpdateBusinessMetadata"); + scope.Start(); + try + { + using HttpMessage message = CreateAddOrUpdateBusinessMetadataRequest(guid, content, isOverwrite, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add business metadata to an entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether to overwrite the existing business metadata on the entity or not, default is false. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AddOrUpdateBusinessMetadata(string guid, RequestContent content, bool? isOverwrite = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddOrUpdateBusinessMetadata"); + scope.Start(); + try + { + using HttpMessage message = CreateAddOrUpdateBusinessMetadataRequest(guid, content, isOverwrite, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete business metadata attributes from an entity. + /// The globally unique identifier of the entity. + /// BusinessMetadata name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteBusinessMetadataAttributesAsync(string guid, string bmName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(bmName, nameof(bmName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteBusinessMetadataAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteBusinessMetadataAttributesRequest(guid, bmName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete business metadata attributes from an entity. + /// The globally unique identifier of the entity. + /// BusinessMetadata name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteBusinessMetadataAttributes(string guid, string bmName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(bmName, nameof(bmName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteBusinessMetadataAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteBusinessMetadataAttributesRequest(guid, bmName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add or update business metadata attributes. + /// The globally unique identifier of the entity. + /// BusinessMetadata name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AddOrUpdateBusinessMetadataAttributesAsync(string guid, string bmName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(bmName, nameof(bmName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddOrUpdateBusinessMetadataAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateAddOrUpdateBusinessMetadataAttributesRequest(guid, bmName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add or update business metadata attributes. + /// The globally unique identifier of the entity. + /// BusinessMetadata name. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AddOrUpdateBusinessMetadataAttributes(string guid, string bmName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNullOrEmpty(bmName, nameof(bmName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddOrUpdateBusinessMetadataAttributes"); + scope.Start(); + try + { + using HttpMessage message = CreateAddOrUpdateBusinessMetadataAttributesRequest(guid, bmName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the sample Template for uploading/creating bulk BusinessMetaData. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetSampleBusinessMetadataTemplateAsync(RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetSampleBusinessMetadataTemplate"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSampleBusinessMetadataTemplateRequest(context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the sample Template for uploading/creating bulk BusinessMetaData. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetSampleBusinessMetadataTemplate(RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("EntityClient.GetSampleBusinessMetadataTemplate"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSampleBusinessMetadataTemplateRequest(context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Upload the file for creating Business Metadata in BULK. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task ImportBusinessMetadataAsync(RequestContent content, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("EntityClient.ImportBusinessMetadata"); + scope.Start(); + try + { + using HttpMessage message = CreateImportBusinessMetadataRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Upload the file for creating Business Metadata in BULK. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response ImportBusinessMetadata(RequestContent content, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("EntityClient.ImportBusinessMetadata"); + scope.Start(); + try + { + using HttpMessage message = CreateImportBusinessMetadataRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// delete given labels to a given entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteLabelsAsync(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteLabels"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteLabelsRequest(guid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// delete given labels to a given entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteLabels(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteLabels"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteLabelsRequest(guid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Set labels to a given entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task SetLabelsAsync(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.SetLabels"); + scope.Start(); + try + { + using HttpMessage message = CreateSetLabelsRequest(guid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Set labels to a given entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response SetLabels(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.SetLabels"); + scope.Start(); + try + { + using HttpMessage message = CreateSetLabelsRequest(guid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// add given labels to a given entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AddLabelAsync(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddLabel"); + scope.Start(); + try + { + using HttpMessage message = CreateAddLabelRequest(guid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// add given labels to a given entity. + /// The globally unique identifier of the entity. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AddLabel(string guid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddLabel"); + scope.Start(); + try + { + using HttpMessage message = CreateAddLabelRequest(guid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteLabelsByUniqueAttributeAsync(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteLabelsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteLabelsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteLabelsByUniqueAttribute(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.DeleteLabelsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteLabelsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task SetLabelsByUniqueAttributeAsync(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.SetLabelsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateSetLabelsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response SetLabelsByUniqueAttribute(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.SetLabelsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateSetLabelsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AddLabelsByUniqueAttributeAsync(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddLabelsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateAddLabelsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + /// The name of the type. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The qualified name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AddLabelsByUniqueAttribute(string typeName, RequestContent content, string attrQualifiedName = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + + using var scope = ClientDiagnostics.CreateScope("EntityClient.AddLabelsByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateAddLabelsByUniqueAttributeRequest(typeName, content, attrQualifiedName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateCreateOrUpdateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetEntitiesByGuidsRequest(IEnumerable guids, bool? minExtInfo, bool? ignoreRelationships, IEnumerable excludeRelationshipTypes, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/bulk", false); + foreach (var param in guids) + { + uri.AppendQuery("guid", param, true); + } + if (minExtInfo != null) + { + uri.AppendQuery("minExtInfo", minExtInfo.Value, true); + } + if (ignoreRelationships != null) + { + uri.AppendQuery("ignoreRelationships", ignoreRelationships.Value, true); + } + if (excludeRelationshipTypes != null) + { + foreach (var param0 in excludeRelationshipTypes) + { + uri.AppendQuery("excludeRelationshipTypes", param0, true); + } + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateEntitiesRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/bulk", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteByGuidsRequest(IEnumerable guids, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/bulk", false); + foreach (var param in guids) + { + uri.AppendQuery("guid", param, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateAddClassificationRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/bulk/classification", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetByGuidRequest(string guid, bool? minExtInfo, bool? ignoreRelationships, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + if (minExtInfo != null) + { + uri.AppendQuery("minExtInfo", minExtInfo.Value, true); + } + if (ignoreRelationships != null) + { + uri.AppendQuery("ignoreRelationships", ignoreRelationships.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreatePartialUpdateEntityAttributeByGuidRequest(string guid, string name, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendQuery("name", name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetClassificationRequest(string guid, string classificationName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/classification/", false); + uri.AppendPath(classificationName, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateDeleteClassificationRequest(string guid, string classificationName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/classification/", false); + uri.AppendPath(classificationName, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetClassificationsRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/classifications", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateAddClassificationsRequest(string guid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/classifications", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateUpdateClassificationsRequest(string guid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/classifications", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetByUniqueAttributesRequest(string typeName, bool? minExtInfo, bool? ignoreRelationships, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + if (minExtInfo != null) + { + uri.AppendQuery("minExtInfo", minExtInfo.Value, true); + } + if (ignoreRelationships != null) + { + uri.AppendQuery("ignoreRelationships", ignoreRelationships.Value, true); + } + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreatePartialUpdateEntityByUniqueAttributesRequest(string typeName, RequestContent content, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteByUniqueAttributeRequest(string typeName, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateDeleteClassificationByUniqueAttributeRequest(string typeName, string classificationName, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + uri.AppendPath("/classification/", false); + uri.AppendPath(classificationName, true); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateAddClassificationsByUniqueAttributeRequest(string typeName, RequestContent content, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + uri.AppendPath("/classifications", false); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateUpdateClassificationsByUniqueAttributeRequest(string typeName, RequestContent content, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + uri.AppendPath("/classifications", false); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateSetClassificationsRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/bulk/setClassifications", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetEntitiesByUniqueAttributesRequest(string typeName, bool? minExtInfo, bool? ignoreRelationships, string attrNQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/bulk/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + if (minExtInfo != null) + { + uri.AppendQuery("minExtInfo", minExtInfo.Value, true); + } + if (ignoreRelationships != null) + { + uri.AppendQuery("ignoreRelationships", ignoreRelationships.Value, true); + } + if (attrNQualifiedName != null) + { + uri.AppendQuery("attr_N:qualifiedName", attrNQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetHeaderRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/header", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateDeleteBusinessMetadataRequest(string guid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/businessmetadata", false); + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateAddOrUpdateBusinessMetadataRequest(string guid, RequestContent content, bool? isOverwrite, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/businessmetadata", false); + if (isOverwrite != null) + { + uri.AppendQuery("isOverwrite", isOverwrite.Value, true); + } + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteBusinessMetadataAttributesRequest(string guid, string bmName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/businessmetadata/", false); + uri.AppendPath(bmName, true); + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateAddOrUpdateBusinessMetadataAttributesRequest(string guid, string bmName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/businessmetadata/", false); + uri.AppendPath(bmName, true); + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetSampleBusinessMetadataTemplateRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/businessmetadata/import/template", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/octet-stream"); + return message; + } + + internal HttpMessage CreateImportBusinessMetadataRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/businessmetadata/import", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "multipart/form-data"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteLabelsRequest(string guid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/labels", false); + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateSetLabelsRequest(string guid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/labels", false); + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateAddLabelRequest(string guid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/guid/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/labels", false); + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteLabelsByUniqueAttributeRequest(string typeName, RequestContent content, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + uri.AppendPath("/labels", false); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateSetLabelsByUniqueAttributeRequest(string typeName, RequestContent content, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + uri.AppendPath("/labels", false); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateAddLabelsByUniqueAttributeRequest(string typeName, RequestContent content, string attrQualifiedName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/entity/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + uri.AppendPath("/labels", false); + if (attrQualifiedName != null) + { + uri.AppendQuery("attr:qualifiedName", attrQualifiedName, true); + } + request.Uri = uri; + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier204; + private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/FiltersClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/FiltersClient.cs new file mode 100644 index 000000000000..1f9d265fb97c --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/FiltersClient.cs @@ -0,0 +1,218 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Filters service client. + /// The Filters service client. + public partial class FiltersClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of FiltersClient for mocking. + protected FiltersClient() + { + } + + /// Initializes a new instance of FiltersClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public FiltersClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of FiltersClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public FiltersClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get a filter. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetFilterAsync(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("FiltersClient.GetFilter"); + scope.Start(); + try + { + using HttpMessage message = CreateGetFilterRequest(dataSourceName, scanName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a filter. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetFilter(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("FiltersClient.GetFilter"); + scope.Start(); + try + { + using HttpMessage message = CreateGetFilterRequest(dataSourceName, scanName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates or updates a filter. + /// The String to use. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string dataSourceName, string scanName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("FiltersClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, scanName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates or updates a filter. + /// The String to use. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string dataSourceName, string scanName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("FiltersClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, scanName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetFilterRequest(string dataSourceName, string scanName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/filters/custom", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string dataSourceName, string scanName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/filters/custom", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/GlossaryClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/GlossaryClient.cs new file mode 100644 index 000000000000..40a214fda7ac --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/GlossaryClient.cs @@ -0,0 +1,2759 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Glossary service client. + /// The Glossary service client. + public partial class GlossaryClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of GlossaryClient for mocking. + protected GlossaryClient() + { + } + + /// Initializes a new instance of GlossaryClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public GlossaryClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of GlossaryClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public GlossaryClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get all glossaries registered with Atlas. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// Whether ignore terms and categories. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossariesAsync(int? limit = null, int? offset = null, string sort = null, bool? ignoreTermsAndCategories = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaries"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossariesRequest(limit, offset, sort, ignoreTermsAndCategories, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all glossaries registered with Atlas. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// Whether ignore terms and categories. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossaries(int? limit = null, int? offset = null, string sort = null, bool? ignoreTermsAndCategories = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaries"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossariesRequest(limit, offset, sort, ignoreTermsAndCategories, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateGlossaryAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateGlossary(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create glossary category in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateGlossaryCategoriesAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryCategories"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryCategoriesRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create glossary category in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateGlossaryCategories(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryCategories"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryCategoriesRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a glossary category. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateGlossaryCategoryAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryCategoryRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a glossary category. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateGlossaryCategory(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryCategoryRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get specific glossary category by its GUID. + /// The globally unique identifier of the category. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossaryCategoryAsync(string categoryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryCategoryRequest(categoryGuid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get specific glossary category by its GUID. + /// The globally unique identifier of the category. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossaryCategory(string categoryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryCategoryRequest(categoryGuid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the given glossary category by its GUID. + /// The globally unique identifier of the category. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task UpdateGlossaryCategoryAsync(string categoryGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.UpdateGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateGlossaryCategoryRequest(categoryGuid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the given glossary category by its GUID. + /// The globally unique identifier of the category. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response UpdateGlossaryCategory(string categoryGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.UpdateGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateGlossaryCategoryRequest(categoryGuid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a glossary category. + /// The globally unique identifier of the category. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteGlossaryCategoryAsync(string categoryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteGlossaryCategoryRequest(categoryGuid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a glossary category. + /// The globally unique identifier of the category. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteGlossaryCategory(string categoryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteGlossaryCategoryRequest(categoryGuid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the glossary category partially. + /// The globally unique identifier of the category. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task PartialUpdateGlossaryCategoryAsync(string categoryGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.PartialUpdateGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateGlossaryCategoryRequest(categoryGuid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the glossary category partially. + /// The globally unique identifier of the category. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response PartialUpdateGlossaryCategory(string categoryGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.PartialUpdateGlossaryCategory"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateGlossaryCategoryRequest(categoryGuid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. + /// The globally unique identifier of the category. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetRelatedCategoriesAsync(string categoryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetRelatedCategories"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelatedCategoriesRequest(categoryGuid, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. + /// The globally unique identifier of the category. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetRelatedCategories(string categoryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetRelatedCategories"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelatedCategoriesRequest(categoryGuid, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all terms associated with the specific category. + /// The globally unique identifier of the category. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetCategoryTermsAsync(string categoryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetCategoryTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateGetCategoryTermsRequest(categoryGuid, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all terms associated with the specific category. + /// The globally unique identifier of the category. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetCategoryTerms(string categoryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(categoryGuid, nameof(categoryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetCategoryTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateGetCategoryTermsRequest(categoryGuid, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateGlossaryTermAsync(RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryTermRequest(content, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateGlossaryTerm(RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryTermRequest(content, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a specific glossary term by its GUID. + /// The globally unique identifier for glossary term. + /// Whether include term hierarchy. + /// An array of relationship types which need to be excluded. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossaryTermAsync(string termGuid, bool? includeTermHierarchy = null, IEnumerable excludeRelationshipTypeList = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryTermRequest(termGuid, includeTermHierarchy, excludeRelationshipTypeList, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a specific glossary term by its GUID. + /// The globally unique identifier for glossary term. + /// Whether include term hierarchy. + /// An array of relationship types which need to be excluded. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossaryTerm(string termGuid, bool? includeTermHierarchy = null, IEnumerable excludeRelationshipTypeList = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryTermRequest(termGuid, includeTermHierarchy, excludeRelationshipTypeList, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the given glossary term by its GUID. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task UpdateGlossaryTermAsync(string termGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.UpdateGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateGlossaryTermRequest(termGuid, content, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the given glossary term by its GUID. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response UpdateGlossaryTerm(string termGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.UpdateGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateGlossaryTermRequest(termGuid, content, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a glossary term. + /// The globally unique identifier for glossary term. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteGlossaryTermAsync(string termGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteGlossaryTermRequest(termGuid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a glossary term. + /// The globally unique identifier for glossary term. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteGlossaryTerm(string termGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteGlossaryTermRequest(termGuid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the glossary term partially. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task PartialUpdateGlossaryTermAsync(string termGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.PartialUpdateGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateGlossaryTermRequest(termGuid, content, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the glossary term partially. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response PartialUpdateGlossaryTerm(string termGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.PartialUpdateGlossaryTerm"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateGlossaryTermRequest(termGuid, content, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create glossary terms in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateGlossaryTermsAsync(RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryTermsRequest(content, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create glossary terms in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateGlossaryTerms(RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.CreateGlossaryTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateGlossaryTermsRequest(content, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all related objects assigned with the specified term. + /// The globally unique identifier for glossary term. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetEntitiesAssignedWithTermAsync(string termGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetEntitiesAssignedWithTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntitiesAssignedWithTermRequest(termGuid, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all related objects assigned with the specified term. + /// The globally unique identifier for glossary term. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetEntitiesAssignedWithTerm(string termGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetEntitiesAssignedWithTerm"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntitiesAssignedWithTermRequest(termGuid, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Assign the given term to the provided list of related objects. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AssignTermToEntitiesAsync(string termGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.AssignTermToEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateAssignTermToEntitiesRequest(termGuid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Assign the given term to the provided list of related objects. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AssignTermToEntities(string termGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.AssignTermToEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateAssignTermToEntitiesRequest(termGuid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete the term assignment for the given list of related objects. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task RemoveTermAssignmentFromEntitiesAsync(string termGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.RemoveTermAssignmentFromEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateRemoveTermAssignmentFromEntitiesRequest(termGuid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete the term assignment for the given list of related objects. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response RemoveTermAssignmentFromEntities(string termGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.RemoveTermAssignmentFromEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateRemoveTermAssignmentFromEntitiesRequest(termGuid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete the term assignment for the given list of related objects. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteTermAssignmentFromEntitiesAsync(string termGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteTermAssignmentFromEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTermAssignmentFromEntitiesRequest(termGuid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete the term assignment for the given list of related objects. + /// The globally unique identifier for glossary term. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteTermAssignmentFromEntities(string termGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteTermAssignmentFromEntities"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTermAssignmentFromEntitiesRequest(termGuid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. + /// The globally unique identifier for glossary term. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetRelatedTermsAsync(string termGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetRelatedTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelatedTermsRequest(termGuid, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. + /// The globally unique identifier for glossary term. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetRelatedTerms(string termGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(termGuid, nameof(termGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetRelatedTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelatedTermsRequest(termGuid, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a specific Glossary by its GUID. + /// The globally unique identifier for glossary. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossaryAsync(string glossaryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryRequest(glossaryGuid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a specific Glossary by its GUID. + /// The globally unique identifier for glossary. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossary(string glossaryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryRequest(glossaryGuid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the given glossary. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task UpdateGlossaryAsync(string glossaryGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.UpdateGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateGlossaryRequest(glossaryGuid, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the given glossary. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response UpdateGlossary(string glossaryGuid, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.UpdateGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateGlossaryRequest(glossaryGuid, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a glossary. + /// The globally unique identifier for glossary. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteGlossaryAsync(string glossaryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteGlossaryRequest(glossaryGuid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a glossary. + /// The globally unique identifier for glossary. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteGlossary(string glossaryGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.DeleteGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteGlossaryRequest(glossaryGuid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the categories belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossaryCategoriesAsync(string glossaryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryCategories"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryCategoriesRequest(glossaryGuid, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the categories belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossaryCategories(string glossaryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryCategories"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryCategoriesRequest(glossaryGuid, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the category headers belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossaryCategoriesHeadersAsync(string glossaryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryCategoriesHeaders"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryCategoriesHeadersRequest(glossaryGuid, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the category headers belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossaryCategoriesHeaders(string glossaryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryCategoriesHeaders"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryCategoriesHeadersRequest(glossaryGuid, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a specific glossary with detailed information. + /// The globally unique identifier for glossary. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetDetailedGlossaryAsync(string glossaryGuid, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetDetailedGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDetailedGlossaryRequest(glossaryGuid, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a specific glossary with detailed information. + /// The globally unique identifier for glossary. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetDetailedGlossary(string glossaryGuid, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetDetailedGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDetailedGlossaryRequest(glossaryGuid, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task PartialUpdateGlossaryAsync(string glossaryGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.PartialUpdateGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateGlossaryRequest(glossaryGuid, content, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response PartialUpdateGlossary(string glossaryGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.PartialUpdateGlossary"); + scope.Start(); + try + { + using HttpMessage message = CreatePartialUpdateGlossaryRequest(glossaryGuid, content, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get terms belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// Whether include term hierarchy. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossaryTermsAsync(string glossaryGuid, bool? includeTermHierarchy = null, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryTermsRequest(glossaryGuid, includeTermHierarchy, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get terms belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// Whether include term hierarchy. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossaryTerms(string glossaryGuid, bool? includeTermHierarchy = null, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryTerms"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryTermsRequest(glossaryGuid, includeTermHierarchy, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get term headers belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetGlossaryTermHeadersAsync(string glossaryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryTermHeaders"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryTermHeadersRequest(glossaryGuid, limit, offset, sort, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get term headers belonging to a specific glossary. + /// The globally unique identifier for glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// The sort order, ASC (default) or DESC. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetGlossaryTermHeaders(string glossaryGuid, int? limit = null, int? offset = null, string sort = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetGlossaryTermHeaders"); + scope.Start(); + try + { + using HttpMessage message = CreateGetGlossaryTermHeadersRequest(glossaryGuid, limit, offset, sort, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the status of import csv operation. + /// The globally unique identifier for async operation/job. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetImportCsvOperationStatusAsync(string operationGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(operationGuid, nameof(operationGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetImportCsvOperationStatus"); + scope.Start(); + try + { + using HttpMessage message = CreateGetImportCsvOperationStatusRequest(operationGuid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the status of import csv operation. + /// The globally unique identifier for async operation/job. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetImportCsvOperationStatus(string operationGuid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(operationGuid, nameof(operationGuid)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetImportCsvOperationStatus"); + scope.Start(); + try + { + using HttpMessage message = CreateGetImportCsvOperationStatusRequest(operationGuid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Export Glossary Terms as csv file. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task ExportGlossaryTermsAsCsvAsync(string glossaryGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.ExportGlossaryTermsAsCsv"); + scope.Start(); + try + { + using HttpMessage message = CreateExportGlossaryTermsAsCsvRequest(glossaryGuid, content, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Export Glossary Terms as csv file. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response ExportGlossaryTermsAsCsv(string glossaryGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.ExportGlossaryTermsAsCsv"); + scope.Start(); + try + { + using HttpMessage message = CreateExportGlossaryTermsAsCsvRequest(glossaryGuid, content, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get terms by glossary name. + /// The name of the glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetTermsByGlossaryNameAsync(string glossaryName, int? limit = null, int? offset = null, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryName, nameof(glossaryName)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetTermsByGlossaryName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTermsByGlossaryNameRequest(glossaryName, limit, offset, includeTermHierarchy, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get terms by glossary name. + /// The name of the glossary. + /// The page size - by default there is no paging. + /// The offset for pagination purpose. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetTermsByGlossaryName(string glossaryName, int? limit = null, int? offset = null, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryName, nameof(glossaryName)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.GetTermsByGlossaryName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTermsByGlossaryNameRequest(glossaryName, limit, offset, includeTermHierarchy, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Import Glossary Terms from local csv file. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual async Task> ImportGlossaryTermsViaCsvAsync(WaitUntil waitUntil, string glossaryGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.ImportGlossaryTermsViaCsv"); + scope.Start(); + try + { + using HttpMessage message = CreateImportGlossaryTermsViaCsvRequest(glossaryGuid, content, includeTermHierarchy, context); + return await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "GlossaryClient.ImportGlossaryTermsViaCsv", OperationFinalStateVia.AzureAsyncOperation, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Import Glossary Terms from local csv file. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The globally unique identifier for glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual Operation ImportGlossaryTermsViaCsv(WaitUntil waitUntil, string glossaryGuid, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryGuid, nameof(glossaryGuid)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.ImportGlossaryTermsViaCsv"); + scope.Start(); + try + { + using HttpMessage message = CreateImportGlossaryTermsViaCsvRequest(glossaryGuid, content, includeTermHierarchy, context); + return ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "GlossaryClient.ImportGlossaryTermsViaCsv", OperationFinalStateVia.AzureAsyncOperation, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Import Glossary Terms from local csv file by glossaryName. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual async Task> ImportGlossaryTermsViaCsvByGlossaryNameAsync(WaitUntil waitUntil, string glossaryName, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryName, nameof(glossaryName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.ImportGlossaryTermsViaCsvByGlossaryName"); + scope.Start(); + try + { + using HttpMessage message = CreateImportGlossaryTermsViaCsvByGlossaryNameRequest(glossaryName, content, includeTermHierarchy, context); + return await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "GlossaryClient.ImportGlossaryTermsViaCsvByGlossaryName", OperationFinalStateVia.AzureAsyncOperation, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Import Glossary Terms from local csv file by glossaryName. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the glossary. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// Whether include term hierarchy. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service that will contain a object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. + /// + public virtual Operation ImportGlossaryTermsViaCsvByGlossaryName(WaitUntil waitUntil, string glossaryName, RequestContent content, bool? includeTermHierarchy = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(glossaryName, nameof(glossaryName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("GlossaryClient.ImportGlossaryTermsViaCsvByGlossaryName"); + scope.Start(); + try + { + using HttpMessage message = CreateImportGlossaryTermsViaCsvByGlossaryNameRequest(glossaryName, content, includeTermHierarchy, context); + return ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "GlossaryClient.ImportGlossaryTermsViaCsvByGlossaryName", OperationFinalStateVia.AzureAsyncOperation, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetGlossariesRequest(int? limit, int? offset, string sort, bool? ignoreTermsAndCategories, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + if (ignoreTermsAndCategories != null) + { + uri.AppendQuery("ignoreTermsAndCategories", ignoreTermsAndCategories.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateGlossaryRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateCreateGlossaryCategoriesRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/categories", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateCreateGlossaryCategoryRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/category", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetGlossaryCategoryRequest(string categoryGuid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/category/", false); + uri.AppendPath(categoryGuid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateUpdateGlossaryCategoryRequest(string categoryGuid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/category/", false); + uri.AppendPath(categoryGuid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteGlossaryCategoryRequest(string categoryGuid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/category/", false); + uri.AppendPath(categoryGuid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreatePartialUpdateGlossaryCategoryRequest(string categoryGuid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/category/", false); + uri.AppendPath(categoryGuid, true); + uri.AppendPath("/partial", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetRelatedCategoriesRequest(string categoryGuid, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/category/", false); + uri.AppendPath(categoryGuid, true); + uri.AppendPath("/related", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetCategoryTermsRequest(string categoryGuid, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/category/", false); + uri.AppendPath(categoryGuid, true); + uri.AppendPath("/terms", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateGlossaryTermRequest(RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/term", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetGlossaryTermRequest(string termGuid, bool? includeTermHierarchy, IEnumerable excludeRelationshipTypeList, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/term/", false); + uri.AppendPath(termGuid, true); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + if (excludeRelationshipTypeList != null) + { + foreach (var param in excludeRelationshipTypeList) + { + uri.AppendQuery("excludeRelationshipTypes", param, true); + } + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateUpdateGlossaryTermRequest(string termGuid, RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/term/", false); + uri.AppendPath(termGuid, true); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteGlossaryTermRequest(string termGuid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/term/", false); + uri.AppendPath(termGuid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreatePartialUpdateGlossaryTermRequest(string termGuid, RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/term/", false); + uri.AppendPath(termGuid, true); + uri.AppendPath("/partial", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateCreateGlossaryTermsRequest(RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/terms", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetEntitiesAssignedWithTermRequest(string termGuid, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/terms/", false); + uri.AppendPath(termGuid, true); + uri.AppendPath("/assignedEntities", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateAssignTermToEntitiesRequest(string termGuid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/terms/", false); + uri.AppendPath(termGuid, true); + uri.AppendPath("/assignedEntities", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateRemoveTermAssignmentFromEntitiesRequest(string termGuid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/terms/", false); + uri.AppendPath(termGuid, true); + uri.AppendPath("/assignedEntities", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteTermAssignmentFromEntitiesRequest(string termGuid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/terms/", false); + uri.AppendPath(termGuid, true); + uri.AppendPath("/assignedEntities", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetRelatedTermsRequest(string termGuid, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/terms/", false); + uri.AppendPath(termGuid, true); + uri.AppendPath("/related", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetGlossaryRequest(string glossaryGuid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateUpdateGlossaryRequest(string glossaryGuid, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteGlossaryRequest(string glossaryGuid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetGlossaryCategoriesRequest(string glossaryGuid, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/categories", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetGlossaryCategoriesHeadersRequest(string glossaryGuid, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/categories/headers", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetDetailedGlossaryRequest(string glossaryGuid, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/detailed", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreatePartialUpdateGlossaryRequest(string glossaryGuid, RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/partial", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetGlossaryTermsRequest(string glossaryGuid, bool? includeTermHierarchy, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/terms", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetGlossaryTermHeadersRequest(string glossaryGuid, int? limit, int? offset, string sort, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/terms/headers", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (sort != null) + { + uri.AppendQuery("sort", sort, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateImportGlossaryTermsViaCsvRequest(string glossaryGuid, RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/terms/import", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "multipart/form-data"); + request.Content = content; + return message; + } + + internal HttpMessage CreateImportGlossaryTermsViaCsvByGlossaryNameRequest(string glossaryName, RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/glossary/name/", false); + uri.AppendPath(glossaryName, true); + uri.AppendPath("/terms/import", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "multipart/form-data"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetImportCsvOperationStatusRequest(string operationGuid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/glossary/terms/import/", false); + uri.AppendPath(operationGuid, true); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateExportGlossaryTermsAsCsvRequest(string glossaryGuid, RequestContent content, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/glossary/", false); + uri.AppendPath(glossaryGuid, true); + uri.AppendPath("/terms/export", false); + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "text/csv"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetTermsByGlossaryNameRequest(string glossaryName, int? limit, int? offset, bool? includeTermHierarchy, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/glossary/name/", false); + uri.AppendPath(glossaryName, true); + uri.AppendPath("/terms", false); + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (includeTermHierarchy != null) + { + uri.AppendQuery("includeTermHierarchy", includeTermHierarchy.Value, true); + } + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier204; + private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/KeyVaultConnectionsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/KeyVaultConnectionsClient.cs new file mode 100644 index 000000000000..0dc64bb08b6c --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/KeyVaultConnectionsClient.cs @@ -0,0 +1,357 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The KeyVaultConnections service client. + /// The KeyVaultConnections service client. + public partial class KeyVaultConnectionsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of KeyVaultConnectionsClient for mocking. + protected KeyVaultConnectionsClient() + { + } + + /// Initializes a new instance of KeyVaultConnectionsClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public KeyVaultConnectionsClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of KeyVaultConnectionsClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public KeyVaultConnectionsClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Gets key vault information. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetKeyVaultConnectionAsync(string keyVaultName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(keyVaultName, nameof(keyVaultName)); + + using var scope = ClientDiagnostics.CreateScope("KeyVaultConnectionsClient.GetKeyVaultConnection"); + scope.Start(); + try + { + using HttpMessage message = CreateGetKeyVaultConnectionRequest(keyVaultName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets key vault information. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetKeyVaultConnection(string keyVaultName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(keyVaultName, nameof(keyVaultName)); + + using var scope = ClientDiagnostics.CreateScope("KeyVaultConnectionsClient.GetKeyVaultConnection"); + scope.Start(); + try + { + using HttpMessage message = CreateGetKeyVaultConnectionRequest(keyVaultName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates an instance of a key vault connection. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateAsync(string keyVaultName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(keyVaultName, nameof(keyVaultName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("KeyVaultConnectionsClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(keyVaultName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates an instance of a key vault connection. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Create(string keyVaultName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(keyVaultName, nameof(keyVaultName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("KeyVaultConnectionsClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(keyVaultName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes the key vault connection associated with the account. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteAsync(string keyVaultName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(keyVaultName, nameof(keyVaultName)); + + using var scope = ClientDiagnostics.CreateScope("KeyVaultConnectionsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(keyVaultName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes the key vault connection associated with the account. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Delete(string keyVaultName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(keyVaultName, nameof(keyVaultName)); + + using var scope = ClientDiagnostics.CreateScope("KeyVaultConnectionsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(keyVaultName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List key vault connections in account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetKeyVaultConnectionsAsync(RequestContext context = null) + { + return GetKeyVaultConnectionsImplementationAsync("KeyVaultConnectionsClient.GetKeyVaultConnections", context); + } + + private AsyncPageable GetKeyVaultConnectionsImplementationAsync(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetKeyVaultConnectionsRequest(context) + : CreateGetKeyVaultConnectionsNextPageRequest(nextLink, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List key vault connections in account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetKeyVaultConnections(RequestContext context = null) + { + return GetKeyVaultConnectionsImplementation("KeyVaultConnectionsClient.GetKeyVaultConnections", context); + } + + private Pageable GetKeyVaultConnectionsImplementation(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetKeyVaultConnectionsRequest(context) + : CreateGetKeyVaultConnectionsNextPageRequest(nextLink, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetKeyVaultConnectionRequest(string keyVaultName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/azureKeyVaults/", false); + uri.AppendPath(keyVaultName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(string keyVaultName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/azureKeyVaults/", false); + uri.AppendPath(keyVaultName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string keyVaultName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/azureKeyVaults/", false); + uri.AppendPath(keyVaultName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetKeyVaultConnectionsRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/azureKeyVaults", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetKeyVaultConnectionsNextPageRequest(string nextLink, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200204; + private static ResponseClassifier ResponseClassifier200204 => _responseClassifier200204 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/LineageClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/LineageClient.cs new file mode 100644 index 000000000000..5267875c82c7 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/LineageClient.cs @@ -0,0 +1,364 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Lineage service client. + /// The Lineage service client. + public partial class LineageClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of LineageClient for mocking. + protected LineageClient() + { + } + + /// Initializes a new instance of LineageClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public LineageClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of LineageClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public LineageClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get lineage info of the entity specified by GUID. + /// The globally unique identifier of the entity. + /// The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "BOTH" | "INPUT" | "OUTPUT". + /// The number of hops for lineage. + /// The number of max expanding width in lineage. + /// True to include the parent chain in the response. + /// True to include derived lineage in the response. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetLineageGraphAsync(string guid, string direction, int? depth = null, int? width = null, bool? includeParent = null, bool? getDerivedLineage = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(direction, nameof(direction)); + + using var scope = ClientDiagnostics.CreateScope("LineageClient.GetLineageGraph"); + scope.Start(); + try + { + using HttpMessage message = CreateGetLineageGraphRequest(guid, direction, depth, width, includeParent, getDerivedLineage, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get lineage info of the entity specified by GUID. + /// The globally unique identifier of the entity. + /// The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "BOTH" | "INPUT" | "OUTPUT". + /// The number of hops for lineage. + /// The number of max expanding width in lineage. + /// True to include the parent chain in the response. + /// True to include derived lineage in the response. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetLineageGraph(string guid, string direction, int? depth = null, int? width = null, bool? includeParent = null, bool? getDerivedLineage = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(direction, nameof(direction)); + + using var scope = ClientDiagnostics.CreateScope("LineageClient.GetLineageGraph"); + scope.Start(); + try + { + using HttpMessage message = CreateGetLineageGraphRequest(guid, direction, depth, width, includeParent, getDerivedLineage, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Return immediate next page lineage info about entity with pagination. + /// The globally unique identifier of the entity. + /// The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "BOTH" | "INPUT" | "OUTPUT". + /// True to include derived lineage in the response. + /// The offset for pagination purpose. + /// The page size - by default there is no paging. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task NextPageLineageAsync(string guid, string direction, bool? getDerivedLineage = null, int? offset = null, int? limit = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(direction, nameof(direction)); + + using var scope = ClientDiagnostics.CreateScope("LineageClient.NextPageLineage"); + scope.Start(); + try + { + using HttpMessage message = CreateNextPageLineageRequest(guid, direction, getDerivedLineage, offset, limit, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Return immediate next page lineage info about entity with pagination. + /// The globally unique identifier of the entity. + /// The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "BOTH" | "INPUT" | "OUTPUT". + /// True to include derived lineage in the response. + /// The offset for pagination purpose. + /// The page size - by default there is no paging. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response NextPageLineage(string guid, string direction, bool? getDerivedLineage = null, int? offset = null, int? limit = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + Argument.AssertNotNull(direction, nameof(direction)); + + using var scope = ClientDiagnostics.CreateScope("LineageClient.NextPageLineage"); + scope.Start(); + try + { + using HttpMessage message = CreateNextPageLineageRequest(guid, direction, getDerivedLineage, offset, limit, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Returns lineage info about entity. + /// + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format + /// + /// attr:[attrName]=[attrValue] + /// + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName + /// + /// The name of the type. + /// The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "BOTH" | "INPUT" | "OUTPUT". + /// The number of hops for lineage. + /// The number of max expanding width in lineage. + /// True to include the parent chain in the response. + /// True to include derived lineage in the response. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetLineageByUniqueAttributeAsync(string typeName, string direction, int? depth = null, int? width = null, bool? includeParent = null, bool? getDerivedLineage = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(direction, nameof(direction)); + + using var scope = ClientDiagnostics.CreateScope("LineageClient.GetLineageByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateGetLineageByUniqueAttributeRequest(typeName, direction, depth, width, includeParent, getDerivedLineage, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Returns lineage info about entity. + /// + /// In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format + /// + /// attr:[attrName]=[attrValue] + /// + /// NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName + /// + /// The name of the type. + /// The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "BOTH" | "INPUT" | "OUTPUT". + /// The number of hops for lineage. + /// The number of max expanding width in lineage. + /// True to include the parent chain in the response. + /// True to include derived lineage in the response. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetLineageByUniqueAttribute(string typeName, string direction, int? depth = null, int? width = null, bool? includeParent = null, bool? getDerivedLineage = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(typeName, nameof(typeName)); + Argument.AssertNotNull(direction, nameof(direction)); + + using var scope = ClientDiagnostics.CreateScope("LineageClient.GetLineageByUniqueAttribute"); + scope.Start(); + try + { + using HttpMessage message = CreateGetLineageByUniqueAttributeRequest(typeName, direction, depth, width, includeParent, getDerivedLineage, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetLineageGraphRequest(string guid, string direction, int? depth, int? width, bool? includeParent, bool? getDerivedLineage, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/lineage/", false); + uri.AppendPath(guid, true); + uri.AppendQuery("direction", direction, true); + if (depth != null) + { + uri.AppendQuery("depth", depth.Value, true); + } + if (width != null) + { + uri.AppendQuery("width", width.Value, true); + } + if (includeParent != null) + { + uri.AppendQuery("includeParent", includeParent.Value, true); + } + if (getDerivedLineage != null) + { + uri.AppendQuery("getDerivedLineage", getDerivedLineage.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateNextPageLineageRequest(string guid, string direction, bool? getDerivedLineage, int? offset, int? limit, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/lineage/", false); + uri.AppendPath(guid, true); + uri.AppendPath("/next/", false); + uri.AppendQuery("direction", direction, true); + if (getDerivedLineage != null) + { + uri.AppendQuery("getDerivedLineage", getDerivedLineage.Value, true); + } + if (offset != null) + { + uri.AppendQuery("offset", offset.Value, true); + } + if (limit != null) + { + uri.AppendQuery("limit", limit.Value, true); + } + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetLineageByUniqueAttributeRequest(string typeName, string direction, int? depth, int? width, bool? includeParent, bool? getDerivedLineage, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/lineage/uniqueAttribute/type/", false); + uri.AppendPath(typeName, true); + uri.AppendQuery("direction", direction, true); + if (depth != null) + { + uri.AppendQuery("depth", depth.Value, true); + } + if (width != null) + { + uri.AppendQuery("width", width.Value, true); + } + if (includeParent != null) + { + uri.AppendQuery("includeParent", includeParent.Value, true); + } + if (getDerivedLineage != null) + { + uri.AppendQuery("getDerivedLineage", getDerivedLineage.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/MetadataPolicyClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/MetadataPolicyClient.cs new file mode 100644 index 000000000000..7bcbe42f7505 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/MetadataPolicyClient.cs @@ -0,0 +1,297 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The MetadataPolicy service client. + /// The MetadataPolicy service client. + public partial class MetadataPolicyClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + private readonly string _collectionName; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of MetadataPolicyClient for mocking. + protected MetadataPolicyClient() + { + } + + /// Initializes a new instance of MetadataPolicyClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// The String to use. + /// A credential used to authenticate to an Azure Service. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + public MetadataPolicyClient(string endpoint, string collectionName, TokenCredential credential) : this(endpoint, collectionName, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of MetadataPolicyClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// The String to use. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + public MetadataPolicyClient(string endpoint, string collectionName, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNullOrEmpty(collectionName, nameof(collectionName)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + _collectionName = collectionName; + } + + /// Updates a metadata policy. + /// Unique policy id. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task UpdateAsync(string policyId, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(policyId, nameof(policyId)); + + using var scope = ClientDiagnostics.CreateScope("MetadataPolicyClient.Update"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateRequest(policyId, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Updates a metadata policy. + /// Unique policy id. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Update(string policyId, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(policyId, nameof(policyId)); + + using var scope = ClientDiagnostics.CreateScope("MetadataPolicyClient.Update"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateRequest(policyId, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets a metadata policy. + /// Id of an existing policy that needs to be fetched. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetMetadataPolicyAsync(string policyId, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(policyId, nameof(policyId)); + + using var scope = ClientDiagnostics.CreateScope("MetadataPolicyClient.GetMetadataPolicy"); + scope.Start(); + try + { + using HttpMessage message = CreateGetMetadataPolicyRequest(policyId, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets a metadata policy. + /// Id of an existing policy that needs to be fetched. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetMetadataPolicy(string policyId, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(policyId, nameof(policyId)); + + using var scope = ClientDiagnostics.CreateScope("MetadataPolicyClient.GetMetadataPolicy"); + scope.Start(); + try + { + using HttpMessage message = CreateGetMetadataPolicyRequest(policyId, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List or Get metadata policies. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetMetadataPoliciesAsync(RequestContext context = null) + { + return GetMetadataPoliciesImplementationAsync("MetadataPolicyClient.GetMetadataPolicies", context); + } + + private AsyncPageable GetMetadataPoliciesImplementationAsync(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetMetadataPoliciesRequest(context) + : CreateGetMetadataPoliciesNextPageRequest(nextLink, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "values", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List or Get metadata policies. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetMetadataPolicies(RequestContext context = null) + { + return GetMetadataPoliciesImplementation("MetadataPolicyClient.GetMetadataPolicies", context); + } + + private Pageable GetMetadataPoliciesImplementation(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetMetadataPoliciesRequest(context) + : CreateGetMetadataPoliciesNextPageRequest(nextLink, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "values", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetMetadataPoliciesRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/policyStore", false); + uri.AppendPath("/metadataPolicies", false); + uri.AppendQuery("api-version", "2021-07-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateUpdateRequest(string policyId, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/policyStore", false); + uri.AppendPath("/metadataPolicies/", false); + uri.AppendPath(policyId, true); + uri.AppendQuery("api-version", "2021-07-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetMetadataPolicyRequest(string policyId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/policyStore", false); + uri.AppendPath("/metadataPolicies/", false); + uri.AppendPath(policyId, true); + uri.AppendQuery("api-version", "2021-07-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetMetadataPoliciesNextPageRequest(string nextLink, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/policyStore", false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/MetadataRolesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/MetadataRolesClient.cs new file mode 100644 index 000000000000..c3484b596810 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/MetadataRolesClient.cs @@ -0,0 +1,149 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The MetadataRoles service client. + /// The MetadataRoles service client. + public partial class MetadataRolesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of MetadataRolesClient for mocking. + protected MetadataRolesClient() + { + } + + /// Initializes a new instance of MetadataRolesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public MetadataRolesClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of MetadataRolesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public MetadataRolesClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Lists roles for Purview Account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetMetadataRolesAsync(RequestContext context = null) + { + return GetMetadataRolesImplementationAsync("MetadataRolesClient.GetMetadataRoles", context); + } + + private AsyncPageable GetMetadataRolesImplementationAsync(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetMetadataRolesRequest(context) + : CreateGetMetadataRolesNextPageRequest(nextLink, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "values", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Lists roles for Purview Account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetMetadataRoles(RequestContext context = null) + { + return GetMetadataRolesImplementation("MetadataRolesClient.GetMetadataRoles", context); + } + + private Pageable GetMetadataRolesImplementation(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetMetadataRolesRequest(context) + : CreateGetMetadataRolesNextPageRequest(nextLink, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "values", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetMetadataRolesRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/policyStore", false); + uri.AppendPath("/metadataRoles", false); + uri.AppendQuery("api-version", "2021-07-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetMetadataRolesNextPageRequest(string nextLink, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/policyStore", false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PolicyElementsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PolicyElementsClient.cs new file mode 100644 index 000000000000..037a5d2750ca --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PolicyElementsClient.cs @@ -0,0 +1,164 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The PolicyElements service client. + /// The PolicyElements service client. + public partial class PolicyElementsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of PolicyElementsClient for mocking. + protected PolicyElementsClient() + { + } + + /// Initializes a new instance of PolicyElementsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public PolicyElementsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of PolicyElementsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public PolicyElementsClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get policies for given scope. + /// Scope. + /// Optional value to filter policies based on hierarchy of resources. It is of type enum with possible values: AtScope, ChildrenScope, None, All. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetPolicyElementsAsync(string scope, string filter = null, RequestContext context = null) + { + Argument.AssertNotNull(scope, nameof(scope)); + + return GetPolicyElementsImplementationAsync("PolicyElementsClient.GetPolicyElements", scope, filter, context); + } + + private AsyncPageable GetPolicyElementsImplementationAsync(string diagnosticsScopeName, string scope, string filter, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetPolicyElementsRequest(scope, filter, context) + : CreateGetPolicyElementsNextPageRequest(nextLink, scope, filter, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "elements", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Get policies for given scope. + /// Scope. + /// Optional value to filter policies based on hierarchy of resources. It is of type enum with possible values: AtScope, ChildrenScope, None, All. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetPolicyElements(string scope, string filter = null, RequestContext context = null) + { + Argument.AssertNotNull(scope, nameof(scope)); + + return GetPolicyElementsImplementation("PolicyElementsClient.GetPolicyElements", scope, filter, context); + } + + private Pageable GetPolicyElementsImplementation(string diagnosticsScopeName, string scope, string filter, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetPolicyElementsRequest(scope, filter, context) + : CreateGetPolicyElementsNextPageRequest(nextLink, scope, filter, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "elements", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetPolicyElementsRequest(string scope, string filter, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRaw("/pds", false); + uri.AppendPath("/policy-elements", false); + uri.AppendQuery("scope", scope, true); + uri.AppendQuery("api-version", "2022-11-01-preview", true); + if (filter != null) + { + uri.AppendQuery("filter", filter, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetPolicyElementsNextPageRequest(string nextLink, string scope, string filter, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRaw("/pds", false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PolicyEventsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PolicyEventsClient.cs new file mode 100644 index 000000000000..29410d8d28a0 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PolicyEventsClient.cs @@ -0,0 +1,135 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The PolicyEvents service client. + /// The PolicyEvents service client. + public partial class PolicyEventsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of PolicyEventsClient for mocking. + protected PolicyEventsClient() + { + } + + /// Initializes a new instance of PolicyEventsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public PolicyEventsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of PolicyEventsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public PolicyEventsClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get policy events for given scope. + /// Scope. + /// The sync token. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetPolicyEventsAsync(string scope, string syncToken, RequestContext context = null) + { + Argument.AssertNotNull(scope, nameof(scope)); + Argument.AssertNotNull(syncToken, nameof(syncToken)); + + using var scope0 = ClientDiagnostics.CreateScope("PolicyEventsClient.GetPolicyEvents"); + scope0.Start(); + try + { + using HttpMessage message = CreateGetPolicyEventsRequest(scope, syncToken, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope0.Failed(e); + throw; + } + } + + /// Get policy events for given scope. + /// Scope. + /// The sync token. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetPolicyEvents(string scope, string syncToken, RequestContext context = null) + { + Argument.AssertNotNull(scope, nameof(scope)); + Argument.AssertNotNull(syncToken, nameof(syncToken)); + + using var scope0 = ClientDiagnostics.CreateScope("PolicyEventsClient.GetPolicyEvents"); + scope0.Start(); + try + { + using HttpMessage message = CreateGetPolicyEventsRequest(scope, syncToken, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope0.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetPolicyEventsRequest(string scope, string syncToken, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200304); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRaw("/pds", false); + uri.AppendPath("/policy-events", false); + uri.AppendQuery("scope", scope, true); + uri.AppendQuery("syncToken", syncToken, true); + uri.AppendQuery("api-version", "2022-11-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200304; + private static ResponseClassifier ResponseClassifier200304 => _responseClassifier200304 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 304 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewAccountClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewAccountClient.cs deleted file mode 100644 index 9f2fbacc7ec1..000000000000 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewAccountClient.cs +++ /dev/null @@ -1,506 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. - -// - -#nullable disable - -using System; -using System.Collections.Generic; -using System.Runtime.CompilerServices; -using System.Threading; -using System.Threading.Tasks; -using Azure; -using Azure.Core; -using Azure.Core.Pipeline; - -namespace Azure.Analytics.Purview.Account -{ - // Data plane generated client. The PurviewAccount service client. - /// The PurviewAccount service client. - public partial class PurviewAccountClient - { - private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; - private readonly TokenCredential _tokenCredential; - private readonly HttpPipeline _pipeline; - private readonly Uri _endpoint; - private readonly string _apiVersion; - - /// The ClientDiagnostics is used to provide tracing support for the client library. - internal ClientDiagnostics ClientDiagnostics { get; } - - /// The HTTP pipeline for sending and receiving REST requests and responses. - public virtual HttpPipeline Pipeline => _pipeline; - - /// Initializes a new instance of PurviewAccountClient for mocking. - protected PurviewAccountClient() - { - } - - /// Initializes a new instance of PurviewAccountClient. - /// The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/account/. - /// A credential used to authenticate to an Azure Service. - /// or is null. - public PurviewAccountClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) - { - } - - /// Initializes a new instance of PurviewAccountClient. - /// The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/account/. - /// A credential used to authenticate to an Azure Service. - /// The options for configuring the client. - /// or is null. - public PurviewAccountClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) - { - Argument.AssertNotNull(endpoint, nameof(endpoint)); - Argument.AssertNotNull(credential, nameof(credential)); - options ??= new PurviewAccountClientOptions(); - - ClientDiagnostics = new ClientDiagnostics(options, true); - _tokenCredential = credential; - _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); - _endpoint = endpoint; - _apiVersion = options.Version; - } - - /// Get an account. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task GetAccountPropertiesAsync(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.GetAccountProperties"); - scope.Start(); - try - { - using HttpMessage message = CreateGetAccountPropertiesRequest(context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Get an account. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response GetAccountProperties(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.GetAccountProperties"); - scope.Start(); - try - { - using HttpMessage message = CreateGetAccountPropertiesRequest(context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Updates an account. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task UpdateAccountPropertiesAsync(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.UpdateAccountProperties"); - scope.Start(); - try - { - using HttpMessage message = CreateUpdateAccountPropertiesRequest(content, context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Updates an account. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response UpdateAccountProperties(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.UpdateAccountProperties"); - scope.Start(); - try - { - using HttpMessage message = CreateUpdateAccountPropertiesRequest(content, context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// List the authorization keys associated with this account. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task GetAccessKeysAsync(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.GetAccessKeys"); - scope.Start(); - try - { - using HttpMessage message = CreateGetAccessKeysRequest(context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// List the authorization keys associated with this account. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response GetAccessKeys(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.GetAccessKeys"); - scope.Start(); - try - { - using HttpMessage message = CreateGetAccessKeysRequest(context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Regenerate the authorization keys associated with this data catalog. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task RegenerateAccessKeyAsync(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.RegenerateAccessKey"); - scope.Start(); - try - { - using HttpMessage message = CreateRegenerateAccessKeyRequest(content, context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Regenerate the authorization keys associated with this data catalog. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response RegenerateAccessKey(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewAccountClient.RegenerateAccessKey"); - scope.Start(); - try - { - using HttpMessage message = CreateRegenerateAccessKeyRequest(content, context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// List the collections in the account. - /// The String to use. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. - /// - public virtual AsyncPageable GetCollectionsAsync(string skipToken = null, RequestContext context = null) - { - return GetCollectionsImplementationAsync("PurviewAccountClient.GetCollections", skipToken, context); - } - - private AsyncPageable GetCollectionsImplementationAsync(string diagnosticsScopeName, string skipToken, RequestContext context) - { - return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); - async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) - { - do - { - var message = string.IsNullOrEmpty(nextLink) - ? CreateGetCollectionsRequest(skipToken, context) - : CreateGetCollectionsNextPageRequest(nextLink, skipToken, context); - var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); - nextLink = page.ContinuationToken; - yield return page; - } while (!string.IsNullOrEmpty(nextLink)); - } - } - - /// List the collections in the account. - /// The String to use. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. - /// - public virtual Pageable GetCollections(string skipToken = null, RequestContext context = null) - { - return GetCollectionsImplementation("PurviewAccountClient.GetCollections", skipToken, context); - } - - private Pageable GetCollectionsImplementation(string diagnosticsScopeName, string skipToken, RequestContext context) - { - return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); - IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) - { - do - { - var message = string.IsNullOrEmpty(nextLink) - ? CreateGetCollectionsRequest(skipToken, context) - : CreateGetCollectionsNextPageRequest(nextLink, skipToken, context); - var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); - nextLink = page.ContinuationToken; - yield return page; - } while (!string.IsNullOrEmpty(nextLink)); - } - } - - /// Get a resource set config service model. - /// The String to use. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. - /// - public virtual AsyncPageable GetResourceSetRulesAsync(string skipToken = null, RequestContext context = null) - { - return GetResourceSetRulesImplementationAsync("PurviewAccountClient.GetResourceSetRules", skipToken, context); - } - - private AsyncPageable GetResourceSetRulesImplementationAsync(string diagnosticsScopeName, string skipToken, RequestContext context) - { - return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); - async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) - { - do - { - var message = string.IsNullOrEmpty(nextLink) - ? CreateGetResourceSetRulesRequest(skipToken, context) - : CreateGetResourceSetRulesNextPageRequest(nextLink, skipToken, context); - var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); - nextLink = page.ContinuationToken; - yield return page; - } while (!string.IsNullOrEmpty(nextLink)); - } - } - - /// Get a resource set config service model. - /// The String to use. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. - /// - public virtual Pageable GetResourceSetRules(string skipToken = null, RequestContext context = null) - { - return GetResourceSetRulesImplementation("PurviewAccountClient.GetResourceSetRules", skipToken, context); - } - - private Pageable GetResourceSetRulesImplementation(string diagnosticsScopeName, string skipToken, RequestContext context) - { - return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); - IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) - { - do - { - var message = string.IsNullOrEmpty(nextLink) - ? CreateGetResourceSetRulesRequest(skipToken, context) - : CreateGetResourceSetRulesNextPageRequest(nextLink, skipToken, context); - var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); - nextLink = page.ContinuationToken; - yield return page; - } while (!string.IsNullOrEmpty(nextLink)); - } - } - - private PurviewResourceSetRule _cachedPurviewResourceSetRule; - - /// Initializes a new instance of PurviewCollection. - /// The String to use. - /// is null. - /// is an empty string, and was expected to be non-empty. - public virtual PurviewCollection GetPurviewCollectionClient(string collectionName) - { - Argument.AssertNotNullOrEmpty(collectionName, nameof(collectionName)); - - return new PurviewCollection(ClientDiagnostics, _pipeline, _tokenCredential, _endpoint, collectionName, _apiVersion); - } - - /// Initializes a new instance of PurviewResourceSetRule. - public virtual PurviewResourceSetRule GetPurviewResourceSetRuleClient() - { - return Volatile.Read(ref _cachedPurviewResourceSetRule) ?? Interlocked.CompareExchange(ref _cachedPurviewResourceSetRule, new PurviewResourceSetRule(ClientDiagnostics, _pipeline, _tokenCredential, _endpoint, _apiVersion), null) ?? _cachedPurviewResourceSetRule; - } - - internal HttpMessage CreateGetAccountPropertiesRequest(RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateUpdateAccountPropertiesRequest(RequestContent content, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Patch; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - request.Headers.Add("Content-Type", "application/json"); - request.Content = content; - return message; - } - - internal HttpMessage CreateGetAccessKeysRequest(RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Post; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/listkeys", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateRegenerateAccessKeyRequest(RequestContent content, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Post; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/regeneratekeys", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - request.Headers.Add("Content-Type", "application/json"); - request.Content = content; - return message; - } - - internal HttpMessage CreateGetCollectionsRequest(string skipToken, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/collections", false); - uri.AppendQuery("api-version", _apiVersion, true); - if (skipToken != null) - { - uri.AppendQuery("$skipToken", skipToken, true); - } - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateGetResourceSetRulesRequest(string skipToken, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/resourceSetRuleConfigs", false); - uri.AppendQuery("api-version", _apiVersion, true); - if (skipToken != null) - { - uri.AppendQuery("$skipToken", skipToken, true); - } - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateGetCollectionsNextPageRequest(string nextLink, string skipToken, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendRawNextLink(nextLink, false); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateGetResourceSetRulesNextPageRequest(string nextLink, string skipToken, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendRawNextLink(nextLink, false); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - private static ResponseClassifier _responseClassifier200; - private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); - } -} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewAccountClientOptions.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewAccountClientOptions.cs index bb4e10039732..632bc49c752b 100644 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewAccountClientOptions.cs +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewAccountClientOptions.cs @@ -10,16 +10,24 @@ namespace Azure.Analytics.Purview.Account { - /// Client options for PurviewAccountClient. + /// Client options for PurviewAccount library clients. public partial class PurviewAccountClientOptions : ClientOptions { - private const ServiceVersion LatestVersion = ServiceVersion.V2019_11_01_Preview; + private const ServiceVersion LatestVersion = ServiceVersion.V2022_11_01_Preview; /// The version of the service to use. public enum ServiceVersion { - /// Service version "2019-11-01-preview". - V2019_11_01_Preview = 1, + /// Service version "2018-12-01-preview". + V2018_12_01_Preview = 1, + /// Service version "2021-07-01-preview". + V2021_07_01_Preview = 2, + /// Service version "2021-09-01-preview". + V2021_09_01_Preview = 3, + /// Service version "2022-03-01-preview". + V2022_03_01_Preview = 4, + /// Service version "2022-11-01-preview". + V2022_11_01_Preview = 5, } internal string Version { get; } @@ -29,7 +37,11 @@ public PurviewAccountClientOptions(ServiceVersion version = LatestVersion) { Version = version switch { - ServiceVersion.V2019_11_01_Preview => "2019-11-01-preview", + ServiceVersion.V2018_12_01_Preview => "2018-12-01-preview", + ServiceVersion.V2021_07_01_Preview => "2021-07-01-preview", + ServiceVersion.V2021_09_01_Preview => "2021-09-01-preview", + ServiceVersion.V2022_03_01_Preview => "2022-03-01-preview", + ServiceVersion.V2022_11_01_Preview => "2022-11-01-preview", _ => throw new NotSupportedException() }; } diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewCollection.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewCollection.cs deleted file mode 100644 index cf14203c8d54..000000000000 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewCollection.cs +++ /dev/null @@ -1,391 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. - -// - -#nullable disable - -using System; -using System.Collections.Generic; -using System.Runtime.CompilerServices; -using System.Threading; -using System.Threading.Tasks; -using Azure; -using Azure.Core; -using Azure.Core.Pipeline; - -namespace Azure.Analytics.Purview.Account -{ - // Data plane generated sub-client. The PurviewCollection sub-client. - /// The PurviewCollection sub-client. - public partial class PurviewCollection - { - private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; - private readonly TokenCredential _tokenCredential; - private readonly HttpPipeline _pipeline; - private readonly Uri _endpoint; - private readonly string _collectionName; - private readonly string _apiVersion; - - /// The ClientDiagnostics is used to provide tracing support for the client library. - internal ClientDiagnostics ClientDiagnostics { get; } - - /// The HTTP pipeline for sending and receiving REST requests and responses. - public virtual HttpPipeline Pipeline => _pipeline; - - /// Initializes a new instance of PurviewCollection for mocking. - protected PurviewCollection() - { - } - - /// Initializes a new instance of PurviewCollection. - /// The handler for diagnostic messaging in the client. - /// The HTTP pipeline for sending and receiving REST requests and responses. - /// The token credential to copy. - /// The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/account/. - /// The String to use. - /// Api Version. - internal PurviewCollection(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, TokenCredential tokenCredential, Uri endpoint, string collectionName, string apiVersion) - { - ClientDiagnostics = clientDiagnostics; - _pipeline = pipeline; - _tokenCredential = tokenCredential; - _endpoint = endpoint; - _collectionName = collectionName; - _apiVersion = apiVersion; - } - - /// Get a collection. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task GetCollectionAsync(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.GetCollection"); - scope.Start(); - try - { - using HttpMessage message = CreateGetCollectionRequest(context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Get a collection. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response GetCollection(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.GetCollection"); - scope.Start(); - try - { - using HttpMessage message = CreateGetCollectionRequest(context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Creates or updates a collection entity. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task CreateOrUpdateCollectionAsync(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.CreateOrUpdateCollection"); - scope.Start(); - try - { - using HttpMessage message = CreateCreateOrUpdateCollectionRequest(content, context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Creates or updates a collection entity. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response CreateOrUpdateCollection(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.CreateOrUpdateCollection"); - scope.Start(); - try - { - using HttpMessage message = CreateCreateOrUpdateCollectionRequest(content, context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Deletes a Collection entity. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. - /// - public virtual async Task DeleteCollectionAsync(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.DeleteCollection"); - scope.Start(); - try - { - using HttpMessage message = CreateDeleteCollectionRequest(context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Deletes a Collection entity. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. - /// - public virtual Response DeleteCollection(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.DeleteCollection"); - scope.Start(); - try - { - using HttpMessage message = CreateDeleteCollectionRequest(context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Gets the parent name and parent friendly name chains that represent the collection path. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task GetCollectionPathAsync(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.GetCollectionPath"); - scope.Start(); - try - { - using HttpMessage message = CreateGetCollectionPathRequest(context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Gets the parent name and parent friendly name chains that represent the collection path. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response GetCollectionPath(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewCollection.GetCollectionPath"); - scope.Start(); - try - { - using HttpMessage message = CreateGetCollectionPathRequest(context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Lists the child collections names in the collection. - /// The String to use. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. - /// - public virtual AsyncPageable GetChildCollectionNamesAsync(string skipToken = null, RequestContext context = null) - { - return GetChildCollectionNamesImplementationAsync("PurviewCollection.GetChildCollectionNames", skipToken, context); - } - - private AsyncPageable GetChildCollectionNamesImplementationAsync(string diagnosticsScopeName, string skipToken, RequestContext context) - { - return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); - async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) - { - do - { - var message = string.IsNullOrEmpty(nextLink) - ? CreateGetChildCollectionNamesRequest(skipToken, context) - : CreateGetChildCollectionNamesNextPageRequest(nextLink, skipToken, context); - var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); - nextLink = page.ContinuationToken; - yield return page; - } while (!string.IsNullOrEmpty(nextLink)); - } - } - - /// Lists the child collections names in the collection. - /// The String to use. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. - /// - public virtual Pageable GetChildCollectionNames(string skipToken = null, RequestContext context = null) - { - return GetChildCollectionNamesImplementation("PurviewCollection.GetChildCollectionNames", skipToken, context); - } - - private Pageable GetChildCollectionNamesImplementation(string diagnosticsScopeName, string skipToken, RequestContext context) - { - return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); - IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) - { - do - { - var message = string.IsNullOrEmpty(nextLink) - ? CreateGetChildCollectionNamesRequest(skipToken, context) - : CreateGetChildCollectionNamesNextPageRequest(nextLink, skipToken, context); - var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); - nextLink = page.ContinuationToken; - yield return page; - } while (!string.IsNullOrEmpty(nextLink)); - } - } - - internal HttpMessage CreateGetCollectionRequest(RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/collections/", false); - uri.AppendPath(_collectionName, true); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateCreateOrUpdateCollectionRequest(RequestContent content, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Put; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/collections/", false); - uri.AppendPath(_collectionName, true); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - request.Headers.Add("Content-Type", "application/json"); - request.Content = content; - return message; - } - - internal HttpMessage CreateDeleteCollectionRequest(RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier204); - var request = message.Request; - request.Method = RequestMethod.Delete; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/collections/", false); - uri.AppendPath(_collectionName, true); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateGetChildCollectionNamesRequest(string skipToken, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/collections/", false); - uri.AppendPath(_collectionName, true); - uri.AppendPath("/getChildCollectionNames", false); - uri.AppendQuery("api-version", _apiVersion, true); - if (skipToken != null) - { - uri.AppendQuery("$skipToken", skipToken, true); - } - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateGetCollectionPathRequest(RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/collections/", false); - uri.AppendPath(_collectionName, true); - uri.AppendPath("/getCollectionPath", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateGetChildCollectionNamesNextPageRequest(string nextLink, string skipToken, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendRawNextLink(nextLink, false); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - private static ResponseClassifier _responseClassifier200; - private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); - private static ResponseClassifier _responseClassifier204; - private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); - } -} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewResourceSetRule.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewResourceSetRule.cs deleted file mode 100644 index 325c6b303113..000000000000 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/PurviewResourceSetRule.cs +++ /dev/null @@ -1,235 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. - -// - -#nullable disable - -using System; -using System.Threading.Tasks; -using Azure; -using Azure.Core; -using Azure.Core.Pipeline; - -namespace Azure.Analytics.Purview.Account -{ - // Data plane generated sub-client. The PurviewResourceSetRule sub-client. - /// The PurviewResourceSetRule sub-client. - public partial class PurviewResourceSetRule - { - private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; - private readonly TokenCredential _tokenCredential; - private readonly HttpPipeline _pipeline; - private readonly Uri _endpoint; - private readonly string _apiVersion; - - /// The ClientDiagnostics is used to provide tracing support for the client library. - internal ClientDiagnostics ClientDiagnostics { get; } - - /// The HTTP pipeline for sending and receiving REST requests and responses. - public virtual HttpPipeline Pipeline => _pipeline; - - /// Initializes a new instance of PurviewResourceSetRule for mocking. - protected PurviewResourceSetRule() - { - } - - /// Initializes a new instance of PurviewResourceSetRule. - /// The handler for diagnostic messaging in the client. - /// The HTTP pipeline for sending and receiving REST requests and responses. - /// The token credential to copy. - /// The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/account/. - /// Api Version. - internal PurviewResourceSetRule(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, TokenCredential tokenCredential, Uri endpoint, string apiVersion) - { - ClientDiagnostics = clientDiagnostics; - _pipeline = pipeline; - _tokenCredential = tokenCredential; - _endpoint = endpoint; - _apiVersion = apiVersion; - } - - /// Get a resource set config service model. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task GetResourceSetRuleAsync(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewResourceSetRule.GetResourceSetRule"); - scope.Start(); - try - { - using HttpMessage message = CreateGetResourceSetRuleRequest(context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Get a resource set config service model. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response GetResourceSetRule(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewResourceSetRule.GetResourceSetRule"); - scope.Start(); - try - { - using HttpMessage message = CreateGetResourceSetRuleRequest(context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Creates or updates an resource set config. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual async Task CreateOrUpdateResourceSetRuleAsync(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewResourceSetRule.CreateOrUpdateResourceSetRule"); - scope.Start(); - try - { - using HttpMessage message = CreateCreateOrUpdateResourceSetRuleRequest(content, context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Creates or updates an resource set config. - /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// is null. - /// Service returned a non-success status code. - /// The response returned from the service. Details of the response body schema are in the Remarks section below. - /// - public virtual Response CreateOrUpdateResourceSetRule(RequestContent content, RequestContext context = null) - { - Argument.AssertNotNull(content, nameof(content)); - - using var scope = ClientDiagnostics.CreateScope("PurviewResourceSetRule.CreateOrUpdateResourceSetRule"); - scope.Start(); - try - { - using HttpMessage message = CreateCreateOrUpdateResourceSetRuleRequest(content, context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Deletes a ResourceSetRuleConfig resource. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. - /// - public virtual async Task DeleteResourceSetRuleAsync(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewResourceSetRule.DeleteResourceSetRule"); - scope.Start(); - try - { - using HttpMessage message = CreateDeleteResourceSetRuleRequest(context); - return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - /// Deletes a ResourceSetRuleConfig resource. - /// The request context, which can override default behaviors of the client pipeline on a per-call basis. - /// Service returned a non-success status code. - /// The response returned from the service. - /// - public virtual Response DeleteResourceSetRule(RequestContext context = null) - { - using var scope = ClientDiagnostics.CreateScope("PurviewResourceSetRule.DeleteResourceSetRule"); - scope.Start(); - try - { - using HttpMessage message = CreateDeleteResourceSetRuleRequest(context); - return _pipeline.ProcessMessage(message, context); - } - catch (Exception e) - { - scope.Failed(e); - throw; - } - } - - internal HttpMessage CreateGetResourceSetRuleRequest(RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Get; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/resourceSetRuleConfigs/defaultResourceSetRuleConfig", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - internal HttpMessage CreateCreateOrUpdateResourceSetRuleRequest(RequestContent content, RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200); - var request = message.Request; - request.Method = RequestMethod.Put; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/resourceSetRuleConfigs/defaultResourceSetRuleConfig", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - request.Headers.Add("Content-Type", "application/json"); - request.Content = content; - return message; - } - - internal HttpMessage CreateDeleteResourceSetRuleRequest(RequestContext context) - { - var message = _pipeline.CreateMessage(context, ResponseClassifier200204); - var request = message.Request; - request.Method = RequestMethod.Delete; - var uri = new RawRequestUriBuilder(); - uri.Reset(_endpoint); - uri.AppendPath("/resourceSetRuleConfigs/defaultResourceSetRuleConfig", false); - uri.AppendQuery("api-version", _apiVersion, true); - request.Uri = uri; - request.Headers.Add("Accept", "application/json"); - return message; - } - - private static ResponseClassifier _responseClassifier200; - private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); - private static ResponseClassifier _responseClassifier200204; - private static ResponseClassifier ResponseClassifier200204 => _responseClassifier200204 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 204 }); - } -} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedAssetsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedAssetsClient.cs new file mode 100644 index 000000000000..44ae6284412b --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedAssetsClient.cs @@ -0,0 +1,165 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The ReceivedAssets service client. + /// The ReceivedAssets service client. + public partial class ReceivedAssetsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of ReceivedAssetsClient for mocking. + protected ReceivedAssetsClient() + { + } + + /// Initializes a new instance of ReceivedAssetsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public ReceivedAssetsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of ReceivedAssetsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public ReceivedAssetsClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// List source asset of a received share. + /// The name of the received share. + /// The continuation token to list the next page. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetReceivedAssetsAsync(string receivedShareName, string skipToken = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + return GetReceivedAssetsImplementationAsync("ReceivedAssetsClient.GetReceivedAssets", receivedShareName, skipToken, context); + } + + private AsyncPageable GetReceivedAssetsImplementationAsync(string diagnosticsScopeName, string receivedShareName, string skipToken, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetReceivedAssetsRequest(receivedShareName, skipToken, context) + : CreateGetReceivedAssetsNextPageRequest(nextLink, receivedShareName, skipToken, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List source asset of a received share. + /// The name of the received share. + /// The continuation token to list the next page. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetReceivedAssets(string receivedShareName, string skipToken = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + return GetReceivedAssetsImplementation("ReceivedAssetsClient.GetReceivedAssets", receivedShareName, skipToken, context); + } + + private Pageable GetReceivedAssetsImplementation(string diagnosticsScopeName, string receivedShareName, string skipToken, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetReceivedAssetsRequest(receivedShareName, skipToken, context) + : CreateGetReceivedAssetsNextPageRequest(nextLink, receivedShareName, skipToken, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetReceivedAssetsRequest(string receivedShareName, string skipToken, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendPath("/receivedAssets", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetReceivedAssetsNextPageRequest(string nextLink, string receivedShareName, string skipToken, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedInvitationsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedInvitationsClient.cs new file mode 100644 index 000000000000..495caa52517b --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedInvitationsClient.cs @@ -0,0 +1,313 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The ReceivedInvitations service client. + /// The ReceivedInvitations service client. + public partial class ReceivedInvitationsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of ReceivedInvitationsClient for mocking. + protected ReceivedInvitationsClient() + { + } + + /// Initializes a new instance of ReceivedInvitationsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public ReceivedInvitationsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of ReceivedInvitationsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public ReceivedInvitationsClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Gets the received invitation identified by name. + /// Name of the received invitation. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetReceivedInvitationAsync(string receivedInvitationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedInvitationName, nameof(receivedInvitationName)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedInvitationsClient.GetReceivedInvitation"); + scope.Start(); + try + { + using HttpMessage message = CreateGetReceivedInvitationRequest(receivedInvitationName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets the received invitation identified by name. + /// Name of the received invitation. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetReceivedInvitation(string receivedInvitationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedInvitationName, nameof(receivedInvitationName)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedInvitationsClient.GetReceivedInvitation"); + scope.Start(); + try + { + using HttpMessage message = CreateGetReceivedInvitationRequest(receivedInvitationName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Rejects the received invitation identified by name. + /// Name of the received invitation. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task RejectAsync(string receivedInvitationName, RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedInvitationName, nameof(receivedInvitationName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedInvitationsClient.Reject"); + scope.Start(); + try + { + using HttpMessage message = CreateRejectRequest(receivedInvitationName, content, repeatabilityRequestId, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Rejects the received invitation identified by name. + /// Name of the received invitation. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Reject(string receivedInvitationName, RequestContent content, string repeatabilityRequestId = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedInvitationName, nameof(receivedInvitationName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedInvitationsClient.Reject"); + scope.Start(); + try + { + using HttpMessage message = CreateRejectRequest(receivedInvitationName, content, repeatabilityRequestId, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Lists the received invitations. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetReceivedInvitationsAsync(string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + return GetReceivedInvitationsImplementationAsync("ReceivedInvitationsClient.GetReceivedInvitations", skipToken, filter, orderby, context); + } + + private AsyncPageable GetReceivedInvitationsImplementationAsync(string diagnosticsScopeName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetReceivedInvitationsRequest(skipToken, filter, orderby, context) + : CreateGetReceivedInvitationsNextPageRequest(nextLink, skipToken, filter, orderby, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Lists the received invitations. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetReceivedInvitations(string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + return GetReceivedInvitationsImplementation("ReceivedInvitationsClient.GetReceivedInvitations", skipToken, filter, orderby, context); + } + + private Pageable GetReceivedInvitationsImplementation(string diagnosticsScopeName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetReceivedInvitationsRequest(skipToken, filter, orderby, context) + : CreateGetReceivedInvitationsNextPageRequest(nextLink, skipToken, filter, orderby, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetReceivedInvitationsRequest(string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedInvitations", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (orderby != null) + { + uri.AppendQuery("$orderby", orderby, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetReceivedInvitationRequest(string receivedInvitationName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedInvitations/", false); + uri.AppendPath(receivedInvitationName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateRejectRequest(string receivedInvitationName, RequestContent content, string repeatabilityRequestId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedInvitations/", false); + uri.AppendPath(receivedInvitationName, true); + uri.AppendPath(":reject", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + if (repeatabilityRequestId != null) + { + request.Headers.Add("repeatability-request-id", repeatabilityRequestId); + } + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetReceivedInvitationsNextPageRequest(string nextLink, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedSharesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedSharesClient.cs new file mode 100644 index 000000000000..6c93b484bee1 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ReceivedSharesClient.cs @@ -0,0 +1,379 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The ReceivedShares service client. + /// The ReceivedShares service client. + public partial class ReceivedSharesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of ReceivedSharesClient for mocking. + protected ReceivedSharesClient() + { + } + + /// Initializes a new instance of ReceivedSharesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public ReceivedSharesClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of ReceivedSharesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public ReceivedSharesClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get a received share by name. + /// The name of the received share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetReceivedShareAsync(string receivedShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedSharesClient.GetReceivedShare"); + scope.Start(); + try + { + using HttpMessage message = CreateGetReceivedShareRequest(receivedShareName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a received share by name. + /// The name of the received share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetReceivedShare(string receivedShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedSharesClient.GetReceivedShare"); + scope.Start(); + try + { + using HttpMessage message = CreateGetReceivedShareRequest(receivedShareName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a received share in the given account. + /// The name of the received share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateAsync(string receivedShareName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedSharesClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(receivedShareName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a received share in the given account. + /// The name of the received share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Create(string receivedShareName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedSharesClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(receivedShareName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a list of received shares. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetReceivedSharesAsync(string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + return GetReceivedSharesImplementationAsync("ReceivedSharesClient.GetReceivedShares", skipToken, filter, orderby, context); + } + + private AsyncPageable GetReceivedSharesImplementationAsync(string diagnosticsScopeName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetReceivedSharesRequest(skipToken, filter, orderby, context) + : CreateGetReceivedSharesNextPageRequest(nextLink, skipToken, filter, orderby, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Get a list of received shares. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetReceivedShares(string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + return GetReceivedSharesImplementation("ReceivedSharesClient.GetReceivedShares", skipToken, filter, orderby, context); + } + + private Pageable GetReceivedSharesImplementation(string diagnosticsScopeName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetReceivedSharesRequest(skipToken, filter, orderby, context) + : CreateGetReceivedSharesNextPageRequest(nextLink, skipToken, filter, orderby, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Deletes a received share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the received share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual async Task DeleteAsync(WaitUntil waitUntil, string receivedShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedSharesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(receivedShareName, context); + return await ProtocolOperationHelpers.ProcessMessageWithoutResponseValueAsync(_pipeline, message, ClientDiagnostics, "ReceivedSharesClient.Delete", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a received share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the received share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual Operation Delete(WaitUntil waitUntil, string receivedShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(receivedShareName, nameof(receivedShareName)); + + using var scope = ClientDiagnostics.CreateScope("ReceivedSharesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(receivedShareName, context); + return ProtocolOperationHelpers.ProcessMessageWithoutResponseValue(_pipeline, message, ClientDiagnostics, "ReceivedSharesClient.Delete", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetReceivedSharesRequest(string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (orderby != null) + { + uri.AppendQuery("$orderby", orderby, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetReceivedShareRequest(string receivedShareName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(string receivedShareName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string receivedShareName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/receivedShares/", false); + uri.AppendPath(receivedShareName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetReceivedSharesNextPageRequest(string nextLink, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier201; + private static ResponseClassifier ResponseClassifier201 => _responseClassifier201 ??= new StatusCodeClassifier(stackalloc ushort[] { 201 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/RelationshipClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/RelationshipClient.cs new file mode 100644 index 000000000000..8f1654fef8df --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/RelationshipClient.cs @@ -0,0 +1,338 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Relationship service client. + /// The Relationship service client. + public partial class RelationshipClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of RelationshipClient for mocking. + protected RelationshipClient() + { + } + + /// Initializes a new instance of RelationshipClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public RelationshipClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of RelationshipClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public RelationshipClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Create a new relationship between entities. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a new relationship between entities. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Create(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update an existing relationship between entities. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task UpdateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.Update"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update an existing relationship between entities. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Update(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.Update"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get relationship information between entities by its GUID. + /// The globally unique identifier of the relationship. + /// Limits whether includes extended information. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetRelationshipAsync(string guid, bool? extendedInfo = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.GetRelationship"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelationshipRequest(guid, extendedInfo, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get relationship information between entities by its GUID. + /// The globally unique identifier of the relationship. + /// Limits whether includes extended information. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetRelationship(string guid, bool? extendedInfo = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.GetRelationship"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelationshipRequest(guid, extendedInfo, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a relationship between entities by its GUID. + /// The globally unique identifier of the relationship. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete a relationship between entities by its GUID. + /// The globally unique identifier of the relationship. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("RelationshipClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateCreateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/relationship", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateUpdateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/relationship", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetRelationshipRequest(string guid, bool? extendedInfo, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/relationship/guid/", false); + uri.AppendPath(guid, true); + if (extendedInfo != null) + { + uri.AppendQuery("extendedInfo", extendedInfo.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateDeleteRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/relationship/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier204; + private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScanResultClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScanResultClient.cs new file mode 100644 index 000000000000..dfd68c6690a7 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScanResultClient.cs @@ -0,0 +1,333 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The ScanResult service client. + /// The ScanResult service client. + public partial class ScanResultClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of ScanResultClient for mocking. + protected ScanResultClient() + { + } + + /// Initializes a new instance of ScanResultClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public ScanResultClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of ScanResultClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public ScanResultClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Runs the scan. + /// The String to use. + /// The String to use. + /// The String to use. + /// The ScanLevelType to use. Allowed values: "Full" | "Incremental". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// , or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task RunScanAsync(string dataSourceName, string scanName, string runId, string scanLevel = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNullOrEmpty(runId, nameof(runId)); + + using var scope = ClientDiagnostics.CreateScope("ScanResultClient.RunScan"); + scope.Start(); + try + { + using HttpMessage message = CreateRunScanRequest(dataSourceName, scanName, runId, scanLevel, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Runs the scan. + /// The String to use. + /// The String to use. + /// The String to use. + /// The ScanLevelType to use. Allowed values: "Full" | "Incremental". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// , or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response RunScan(string dataSourceName, string scanName, string runId, string scanLevel = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNullOrEmpty(runId, nameof(runId)); + + using var scope = ClientDiagnostics.CreateScope("ScanResultClient.RunScan"); + scope.Start(); + try + { + using HttpMessage message = CreateRunScanRequest(dataSourceName, scanName, runId, scanLevel, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Cancels a scan. + /// The String to use. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// , or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CancelScanAsync(string dataSourceName, string scanName, string runId, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNullOrEmpty(runId, nameof(runId)); + + using var scope = ClientDiagnostics.CreateScope("ScanResultClient.CancelScan"); + scope.Start(); + try + { + using HttpMessage message = CreateCancelScanRequest(dataSourceName, scanName, runId, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Cancels a scan. + /// The String to use. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// , or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CancelScan(string dataSourceName, string scanName, string runId, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNullOrEmpty(runId, nameof(runId)); + + using var scope = ClientDiagnostics.CreateScope("ScanResultClient.CancelScan"); + scope.Start(); + try + { + using HttpMessage message = CreateCancelScanRequest(dataSourceName, scanName, runId, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Lists the scan history of a scan. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetScanHistoriesAsync(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + return GetScanHistoriesImplementationAsync("ScanResultClient.GetScanHistories", dataSourceName, scanName, context); + } + + private AsyncPageable GetScanHistoriesImplementationAsync(string diagnosticsScopeName, string dataSourceName, string scanName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetScanHistoriesRequest(dataSourceName, scanName, context) + : CreateGetScanHistoriesNextPageRequest(nextLink, dataSourceName, scanName, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Lists the scan history of a scan. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetScanHistories(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + return GetScanHistoriesImplementation("ScanResultClient.GetScanHistories", dataSourceName, scanName, context); + } + + private Pageable GetScanHistoriesImplementation(string diagnosticsScopeName, string dataSourceName, string scanName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetScanHistoriesRequest(dataSourceName, scanName, context) + : CreateGetScanHistoriesNextPageRequest(nextLink, dataSourceName, scanName, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateRunScanRequest(string dataSourceName, string scanName, string runId, string scanLevel, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/runs/", false); + uri.AppendPath(runId, true); + if (scanLevel != null) + { + uri.AppendQuery("scanLevel", scanLevel, true); + } + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCancelScanRequest(string dataSourceName, string scanName, string runId, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/runs/", false); + uri.AppendPath(runId, true); + uri.AppendPath("/:cancel", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetScanHistoriesRequest(string dataSourceName, string scanName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/runs", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetScanHistoriesNextPageRequest(string nextLink, string dataSourceName, string scanName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScanRulesetsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScanRulesetsClient.cs new file mode 100644 index 000000000000..5b8686e380fb --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScanRulesetsClient.cs @@ -0,0 +1,357 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The ScanRulesets service client. + /// The ScanRulesets service client. + public partial class ScanRulesetsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of ScanRulesetsClient for mocking. + protected ScanRulesetsClient() + { + } + + /// Initializes a new instance of ScanRulesetsClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public ScanRulesetsClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of ScanRulesetsClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public ScanRulesetsClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get a scan ruleset. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetScanRulesetAsync(string scanRulesetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(scanRulesetName, nameof(scanRulesetName)); + + using var scope = ClientDiagnostics.CreateScope("ScanRulesetsClient.GetScanRuleset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetScanRulesetRequest(scanRulesetName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a scan ruleset. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetScanRuleset(string scanRulesetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(scanRulesetName, nameof(scanRulesetName)); + + using var scope = ClientDiagnostics.CreateScope("ScanRulesetsClient.GetScanRuleset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetScanRulesetRequest(scanRulesetName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates or Updates a scan ruleset. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string scanRulesetName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(scanRulesetName, nameof(scanRulesetName)); + + using var scope = ClientDiagnostics.CreateScope("ScanRulesetsClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(scanRulesetName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates or Updates a scan ruleset. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string scanRulesetName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(scanRulesetName, nameof(scanRulesetName)); + + using var scope = ClientDiagnostics.CreateScope("ScanRulesetsClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(scanRulesetName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a scan ruleset. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteAsync(string scanRulesetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(scanRulesetName, nameof(scanRulesetName)); + + using var scope = ClientDiagnostics.CreateScope("ScanRulesetsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(scanRulesetName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a scan ruleset. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Delete(string scanRulesetName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(scanRulesetName, nameof(scanRulesetName)); + + using var scope = ClientDiagnostics.CreateScope("ScanRulesetsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(scanRulesetName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List scan rulesets in Data catalog. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetScanRulesetsAsync(RequestContext context = null) + { + return GetScanRulesetsImplementationAsync("ScanRulesetsClient.GetScanRulesets", context); + } + + private AsyncPageable GetScanRulesetsImplementationAsync(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetScanRulesetsRequest(context) + : CreateGetScanRulesetsNextPageRequest(nextLink, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List scan rulesets in Data catalog. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetScanRulesets(RequestContext context = null) + { + return GetScanRulesetsImplementation("ScanRulesetsClient.GetScanRulesets", context); + } + + private Pageable GetScanRulesetsImplementation(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetScanRulesetsRequest(context) + : CreateGetScanRulesetsNextPageRequest(nextLink, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetScanRulesetRequest(string scanRulesetName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/scanrulesets/", false); + uri.AppendPath(scanRulesetName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string scanRulesetName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/scanrulesets/", false); + uri.AppendPath(scanRulesetName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string scanRulesetName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/scanrulesets/", false); + uri.AppendPath(scanRulesetName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetScanRulesetsRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/scanrulesets", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetScanRulesetsNextPageRequest(string nextLink, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier200204; + private static ResponseClassifier ResponseClassifier200204 => _responseClassifier200204 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScansClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScansClient.cs new file mode 100644 index 000000000000..46f261b85470 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/ScansClient.cs @@ -0,0 +1,389 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Scans service client. + /// The Scans service client. + public partial class ScansClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of ScansClient for mocking. + protected ScansClient() + { + } + + /// Initializes a new instance of ScansClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public ScansClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of ScansClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public ScansClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Creates an instance of a scan. + /// The String to use. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string dataSourceName, string scanName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("ScansClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, scanName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates an instance of a scan. + /// The String to use. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string dataSourceName, string scanName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("ScansClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, scanName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets a scan information. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetScanAsync(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("ScansClient.GetScan"); + scope.Start(); + try + { + using HttpMessage message = CreateGetScanRequest(dataSourceName, scanName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets a scan information. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetScan(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("ScansClient.GetScan"); + scope.Start(); + try + { + using HttpMessage message = CreateGetScanRequest(dataSourceName, scanName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes the scan associated with the data source. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteAsync(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("ScansClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(dataSourceName, scanName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes the scan associated with the data source. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response Delete(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("ScansClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(dataSourceName, scanName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List scans in data source. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetScansByDataSourceAsync(string dataSourceName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + return GetScansByDataSourceImplementationAsync("ScansClient.GetScansByDataSource", dataSourceName, context); + } + + private AsyncPageable GetScansByDataSourceImplementationAsync(string diagnosticsScopeName, string dataSourceName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetScansByDataSourceRequest(dataSourceName, context) + : CreateGetScansByDataSourceNextPageRequest(nextLink, dataSourceName, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List scans in data source. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetScansByDataSource(string dataSourceName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + return GetScansByDataSourceImplementation("ScansClient.GetScansByDataSource", dataSourceName, context); + } + + private Pageable GetScansByDataSourceImplementation(string diagnosticsScopeName, string dataSourceName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetScansByDataSourceRequest(dataSourceName, context) + : CreateGetScansByDataSourceNextPageRequest(nextLink, dataSourceName, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateCreateOrUpdateRequest(string dataSourceName, string scanName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetScanRequest(string dataSourceName, string scanName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateDeleteRequest(string dataSourceName, string scanName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetScansByDataSourceRequest(string dataSourceName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetScansByDataSourceNextPageRequest(string nextLink, string dataSourceName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200204; + private static ResponseClassifier ResponseClassifier200204 => _responseClassifier200204 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SentShareInvitationsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SentShareInvitationsClient.cs new file mode 100644 index 000000000000..9d3dcb0249ec --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SentShareInvitationsClient.cs @@ -0,0 +1,407 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The SentShareInvitations service client. + /// The SentShareInvitations service client. + public partial class SentShareInvitationsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of SentShareInvitationsClient for mocking. + protected SentShareInvitationsClient() + { + } + + /// Initializes a new instance of SentShareInvitationsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public SentShareInvitationsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of SentShareInvitationsClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public SentShareInvitationsClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get Invitation for a given share. + /// The name of the sent share. + /// Name of the sent invitation. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetSentShareInvitationAsync(string sentShareName, string sentShareInvitationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(sentShareInvitationName, nameof(sentShareInvitationName)); + + using var scope = ClientDiagnostics.CreateScope("SentShareInvitationsClient.GetSentShareInvitation"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSentShareInvitationRequest(sentShareName, sentShareInvitationName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get Invitation for a given share. + /// The name of the sent share. + /// Name of the sent invitation. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetSentShareInvitation(string sentShareName, string sentShareInvitationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(sentShareInvitationName, nameof(sentShareInvitationName)); + + using var scope = ClientDiagnostics.CreateScope("SentShareInvitationsClient.GetSentShareInvitation"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSentShareInvitationRequest(sentShareName, sentShareInvitationName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create/Update a sent share invitation in the given account. + /// The name of the sent share. + /// Name of the sent invitation. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string sentShareName, string sentShareInvitationName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(sentShareInvitationName, nameof(sentShareInvitationName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SentShareInvitationsClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(sentShareName, sentShareInvitationName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create/Update a sent share invitation in the given account. + /// The name of the sent share. + /// Name of the sent invitation. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string sentShareName, string sentShareInvitationName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(sentShareInvitationName, nameof(sentShareInvitationName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SentShareInvitationsClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(sentShareName, sentShareInvitationName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete Invitation in a share. + /// The name of the sent share. + /// Name of the sent invitation. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string sentShareName, string sentShareInvitationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(sentShareInvitationName, nameof(sentShareInvitationName)); + + using var scope = ClientDiagnostics.CreateScope("SentShareInvitationsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(sentShareName, sentShareInvitationName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete Invitation in a share. + /// The name of the sent share. + /// Name of the sent invitation. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string sentShareName, string sentShareInvitationName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNullOrEmpty(sentShareInvitationName, nameof(sentShareInvitationName)); + + using var scope = ClientDiagnostics.CreateScope("SentShareInvitationsClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(sentShareName, sentShareInvitationName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List all Invitations in a share. + /// The name of the sent share. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetSentShareInvitationsAsync(string sentShareName, string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + return GetSentShareInvitationsImplementationAsync("SentShareInvitationsClient.GetSentShareInvitations", sentShareName, skipToken, filter, orderby, context); + } + + private AsyncPageable GetSentShareInvitationsImplementationAsync(string diagnosticsScopeName, string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetSentShareInvitationsRequest(sentShareName, skipToken, filter, orderby, context) + : CreateGetSentShareInvitationsNextPageRequest(nextLink, sentShareName, skipToken, filter, orderby, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List all Invitations in a share. + /// The name of the sent share. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetSentShareInvitations(string sentShareName, string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + return GetSentShareInvitationsImplementation("SentShareInvitationsClient.GetSentShareInvitations", sentShareName, skipToken, filter, orderby, context); + } + + private Pageable GetSentShareInvitationsImplementation(string diagnosticsScopeName, string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetSentShareInvitationsRequest(sentShareName, skipToken, filter, orderby, context) + : CreateGetSentShareInvitationsNextPageRequest(nextLink, sentShareName, skipToken, filter, orderby, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetSentShareInvitationsRequest(string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/sentShareInvitations", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (orderby != null) + { + uri.AppendQuery("$orderby", orderby, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSentShareInvitationRequest(string sentShareName, string sentShareInvitationName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/sentShareInvitations/", false); + uri.AppendPath(sentShareInvitationName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string sentShareName, string sentShareInvitationName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/sentShareInvitations/", false); + uri.AppendPath(sentShareInvitationName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string sentShareName, string sentShareInvitationName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendPath("/sentShareInvitations/", false); + uri.AppendPath(sentShareInvitationName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSentShareInvitationsNextPageRequest(string nextLink, string sentShareName, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier204; + private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SentSharesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SentSharesClient.cs new file mode 100644 index 000000000000..a686cf792776 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SentSharesClient.cs @@ -0,0 +1,379 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The SentShares service client. + /// The SentShares service client. + public partial class SentSharesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of SentSharesClient for mocking. + protected SentSharesClient() + { + } + + /// Initializes a new instance of SentSharesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public SentSharesClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of SentSharesClient. + /// The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public SentSharesClient(Uri endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get a sent share in the given Purview account. + /// The name of the sent share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetSentShareAsync(string sentShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + using var scope = ClientDiagnostics.CreateScope("SentSharesClient.GetSentShare"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSentShareRequest(sentShareName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a sent share in the given Purview account. + /// The name of the sent share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetSentShare(string sentShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + using var scope = ClientDiagnostics.CreateScope("SentSharesClient.GetSentShare"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSentShareRequest(sentShareName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a sent share in the given Purview account. + /// The name of the sent share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateOrUpdateAsync(string sentShareName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SentSharesClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(sentShareName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Create a sent share in the given Purview account. + /// The name of the sent share. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateOrUpdate(string sentShareName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SentSharesClient.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(sentShareName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get list of sent shares in the given Purview account. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetSentSharesAsync(string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + return GetSentSharesImplementationAsync("SentSharesClient.GetSentShares", skipToken, filter, orderby, context); + } + + private AsyncPageable GetSentSharesImplementationAsync(string diagnosticsScopeName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetSentSharesRequest(skipToken, filter, orderby, context) + : CreateGetSentSharesNextPageRequest(nextLink, skipToken, filter, orderby, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Get list of sent shares in the given Purview account. + /// The continuation token to list the next page. + /// Filters the results using OData syntax. + /// Sorts the results using OData syntax. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetSentShares(string skipToken = null, string filter = null, string orderby = null, RequestContext context = null) + { + return GetSentSharesImplementation("SentSharesClient.GetSentShares", skipToken, filter, orderby, context); + } + + private Pageable GetSentSharesImplementation(string diagnosticsScopeName, string skipToken, string filter, string orderby, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetSentSharesRequest(skipToken, filter, orderby, context) + : CreateGetSentSharesNextPageRequest(nextLink, skipToken, filter, orderby, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// Deletes a sent share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual async Task DeleteAsync(WaitUntil waitUntil, string sentShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + using var scope = ClientDiagnostics.CreateScope("SentSharesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(sentShareName, context); + return await ProtocolOperationHelpers.ProcessMessageWithoutResponseValueAsync(_pipeline, message, ClientDiagnostics, "SentSharesClient.Delete", OperationFinalStateVia.Location, context, waitUntil).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes a sent share. + /// if the method should wait to return until the long-running operation has completed on the service; if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. + /// The name of the sent share. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The representing an asynchronous operation on the service. + /// + public virtual Operation Delete(WaitUntil waitUntil, string sentShareName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(sentShareName, nameof(sentShareName)); + + using var scope = ClientDiagnostics.CreateScope("SentSharesClient.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(sentShareName, context); + return ProtocolOperationHelpers.ProcessMessageWithoutResponseValue(_pipeline, message, ClientDiagnostics, "SentSharesClient.Delete", OperationFinalStateVia.Location, context, waitUntil); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetSentSharesRequest(string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares", false); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + if (skipToken != null) + { + uri.AppendQuery("skipToken", skipToken, true); + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (orderby != null) + { + uri.AppendQuery("$orderby", orderby, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSentShareRequest(string sentShareName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string sentShareName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string sentShareName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/sentShares/", false); + uri.AppendPath(sentShareName, true); + uri.AppendQuery("api-version", "2021-09-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSentSharesNextPageRequest(string nextLink, string skipToken, string filter, string orderby, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SystemScanRulesetsClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SystemScanRulesetsClient.cs new file mode 100644 index 000000000000..2942ca93518f --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/SystemScanRulesetsClient.cs @@ -0,0 +1,429 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The SystemScanRulesets service client. + /// The SystemScanRulesets service client. + public partial class SystemScanRulesetsClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of SystemScanRulesetsClient for mocking. + protected SystemScanRulesetsClient() + { + } + + /// Initializes a new instance of SystemScanRulesetsClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public SystemScanRulesetsClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of SystemScanRulesetsClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public SystemScanRulesetsClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get a system scan ruleset for a data source. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetSystemScanRulesetAsync(string dataSourceType, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceType, nameof(dataSourceType)); + + using var scope = ClientDiagnostics.CreateScope("SystemScanRulesetsClient.GetSystemScanRuleset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSystemScanRulesetRequest(dataSourceType, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a system scan ruleset for a data source. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetSystemScanRuleset(string dataSourceType, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceType, nameof(dataSourceType)); + + using var scope = ClientDiagnostics.CreateScope("SystemScanRulesetsClient.GetSystemScanRuleset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSystemScanRulesetRequest(dataSourceType, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a scan ruleset by version. + /// The Int32 to use. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetByVersionAsync(int version, string dataSourceType = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("SystemScanRulesetsClient.GetByVersion"); + scope.Start(); + try + { + using HttpMessage message = CreateGetByVersionRequest(version, dataSourceType, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get a scan ruleset by version. + /// The Int32 to use. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetByVersion(int version, string dataSourceType = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("SystemScanRulesetsClient.GetByVersion"); + scope.Start(); + try + { + using HttpMessage message = CreateGetByVersionRequest(version, dataSourceType, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the latest version of a system scan ruleset. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetLatestAsync(string dataSourceType = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("SystemScanRulesetsClient.GetLatest"); + scope.Start(); + try + { + using HttpMessage message = CreateGetLatestRequest(dataSourceType, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the latest version of a system scan ruleset. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetLatest(string dataSourceType = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("SystemScanRulesetsClient.GetLatest"); + scope.Start(); + try + { + using HttpMessage message = CreateGetLatestRequest(dataSourceType, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List all system scan rulesets for an account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetSystemScanRulesetsAsync(RequestContext context = null) + { + return GetSystemScanRulesetsImplementationAsync("SystemScanRulesetsClient.GetSystemScanRulesets", context); + } + + private AsyncPageable GetSystemScanRulesetsImplementationAsync(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetSystemScanRulesetsRequest(context) + : CreateGetSystemScanRulesetsNextPageRequest(nextLink, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List all system scan rulesets for an account. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetSystemScanRulesets(RequestContext context = null) + { + return GetSystemScanRulesetsImplementation("SystemScanRulesetsClient.GetSystemScanRulesets", context); + } + + private Pageable GetSystemScanRulesetsImplementation(string diagnosticsScopeName, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetSystemScanRulesetsRequest(context) + : CreateGetSystemScanRulesetsNextPageRequest(nextLink, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List system scan ruleset versions in Data catalog. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetVersionsByDataSourceAsync(string dataSourceType = null, RequestContext context = null) + { + return GetVersionsByDataSourceImplementationAsync("SystemScanRulesetsClient.GetVersionsByDataSource", dataSourceType, context); + } + + private AsyncPageable GetVersionsByDataSourceImplementationAsync(string diagnosticsScopeName, string dataSourceType, RequestContext context) + { + return PageableHelpers.CreateAsyncPageable(CreateEnumerableAsync, ClientDiagnostics, diagnosticsScopeName); + async IAsyncEnumerable> CreateEnumerableAsync(string nextLink, int? pageSizeHint, [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetVersionsByDataSourceRequest(dataSourceType, context) + : CreateGetVersionsByDataSourceNextPageRequest(nextLink, dataSourceType, context); + var page = await LowLevelPageableHelpers.ProcessMessageAsync(_pipeline, message, context, "value", "nextLink", cancellationToken).ConfigureAwait(false); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + /// List system scan ruleset versions in Data catalog. + /// The DataSourceType to use. Allowed values: "None" | "AzureSubscription" | "AzureResourceGroup" | "AzureSynapseWorkspace" | "AzureSynapse" | "AdlsGen1" | "AdlsGen2" | "AmazonAccount" | "AmazonS3" | "AmazonSql" | "AzureCosmosDb" | "AzureDataExplorer" | "AzureFileService" | "AzureSqlDatabase" | "AmazonPostgreSql" | "AzurePostgreSql" | "SqlServerDatabase" | "AzureSqlDatabaseManagedInstance" | "AzureSqlDataWarehouse" | "AzureMySql" | "AzureStorage" | "Teradata" | "Oracle" | "SapS4Hana" | "SapEcc" | "PowerBI". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetVersionsByDataSource(string dataSourceType = null, RequestContext context = null) + { + return GetVersionsByDataSourceImplementation("SystemScanRulesetsClient.GetVersionsByDataSource", dataSourceType, context); + } + + private Pageable GetVersionsByDataSourceImplementation(string diagnosticsScopeName, string dataSourceType, RequestContext context) + { + return PageableHelpers.CreatePageable(CreateEnumerable, ClientDiagnostics, diagnosticsScopeName); + IEnumerable> CreateEnumerable(string nextLink, int? pageSizeHint) + { + do + { + var message = string.IsNullOrEmpty(nextLink) + ? CreateGetVersionsByDataSourceRequest(dataSourceType, context) + : CreateGetVersionsByDataSourceNextPageRequest(nextLink, dataSourceType, context); + var page = LowLevelPageableHelpers.ProcessMessage(_pipeline, message, context, "value", "nextLink"); + nextLink = page.ContinuationToken; + yield return page; + } while (!string.IsNullOrEmpty(nextLink)); + } + } + + internal HttpMessage CreateGetSystemScanRulesetsRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/systemScanRulesets", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSystemScanRulesetRequest(string dataSourceType, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/systemScanRulesets/datasources/", false); + uri.AppendPath(dataSourceType, true); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetByVersionRequest(int version, string dataSourceType, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/systemScanRulesets/versions/", false); + uri.AppendPath(version, true); + if (dataSourceType != null) + { + uri.AppendQuery("dataSourceType", dataSourceType, true); + } + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetLatestRequest(string dataSourceType, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/systemScanRulesets/versions/latest", false); + if (dataSourceType != null) + { + uri.AppendQuery("dataSourceType", dataSourceType, true); + } + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetVersionsByDataSourceRequest(string dataSourceType, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/systemScanRulesets/versions", false); + if (dataSourceType != null) + { + uri.AppendQuery("dataSourceType", dataSourceType, true); + } + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSystemScanRulesetsNextPageRequest(string nextLink, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetVersionsByDataSourceNextPageRequest(string nextLink, string dataSourceType, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRawNextLink(nextLink, false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/TriggersClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/TriggersClient.cs new file mode 100644 index 000000000000..2ff124db40bc --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/TriggersClient.cs @@ -0,0 +1,296 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Triggers service client. + /// The Triggers service client. + public partial class TriggersClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of TriggersClient for mocking. + protected TriggersClient() + { + } + + /// Initializes a new instance of TriggersClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public TriggersClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of TriggersClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public TriggersClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Gets trigger information. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetTriggerAsync(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("TriggersClient.GetTrigger"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTriggerRequest(dataSourceName, scanName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Gets trigger information. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetTrigger(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("TriggersClient.GetTrigger"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTriggerRequest(dataSourceName, scanName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates an instance of a trigger. + /// The String to use. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateTriggerAsync(string dataSourceName, string scanName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TriggersClient.CreateTrigger"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateTriggerRequest(dataSourceName, scanName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates an instance of a trigger. + /// The String to use. + /// The String to use. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateTrigger(string dataSourceName, string scanName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TriggersClient.CreateTrigger"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateTriggerRequest(dataSourceName, scanName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes the trigger associated with the scan. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task DeleteTriggerAsync(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("TriggersClient.DeleteTrigger"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTriggerRequest(dataSourceName, scanName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Deletes the trigger associated with the scan. + /// The String to use. + /// The String to use. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response DeleteTrigger(string dataSourceName, string scanName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNullOrEmpty(scanName, nameof(scanName)); + + using var scope = ClientDiagnostics.CreateScope("TriggersClient.DeleteTrigger"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTriggerRequest(dataSourceName, scanName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetTriggerRequest(string dataSourceName, string scanName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/triggers/default", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateTriggerRequest(string dataSourceName, string scanName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/triggers/default", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteTriggerRequest(string dataSourceName, string scanName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendPath("/datasources/", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("/scans/", false); + uri.AppendPath(scanName, true); + uri.AppendPath("/triggers/default", false); + uri.AppendQuery("api-version", "2018-12-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier200204; + private static ResponseClassifier ResponseClassifier200204 => _responseClassifier200204 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/TypesClient.cs b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/TypesClient.cs new file mode 100644 index 000000000000..ddea26a97b89 --- /dev/null +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/Generated/TypesClient.cs @@ -0,0 +1,1559 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Analytics.Purview.Account +{ + // Data plane generated client. The Types service client. + /// The Types service client. + public partial class TypesClient + { + private static readonly string[] AuthorizationScopes = new string[] { "https://purview.azure.net/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly string _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of TypesClient for mocking. + protected TypesClient() + { + } + + /// Initializes a new instance of TypesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public TypesClient(string endpoint, TokenCredential credential) : this(endpoint, credential, new PurviewAccountClientOptions()) + { + } + + /// Initializes a new instance of TypesClient. + /// The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public TypesClient(string endpoint, TokenCredential credential, PurviewAccountClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new PurviewAccountClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Get the businessMetadata definition for the given guid. + /// businessMetadata guid. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetBusinessMetadataDefByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetBusinessMetadataDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetBusinessMetadataDefByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the businessMetadata definition for the given guid. + /// businessMetadata guid. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetBusinessMetadataDefByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetBusinessMetadataDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetBusinessMetadataDefByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the businessMetadata definition by it's name (unique). + /// businessMetadata name. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetBusinessMetadataDefByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetBusinessMetadataDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetBusinessMetadataDefByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the businessMetadata definition by it's name (unique). + /// businessMetadata name. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetBusinessMetadataDefByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetBusinessMetadataDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetBusinessMetadataDefByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the classification definition for the given GUID. + /// The globally unique identifier of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetClassificationDefByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetClassificationDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationDefByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the classification definition for the given GUID. + /// The globally unique identifier of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetClassificationDefByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetClassificationDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationDefByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the classification definition by its name (unique). + /// The name of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetClassificationDefByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetClassificationDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationDefByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the classification definition by its name (unique). + /// The name of the classification. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetClassificationDefByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetClassificationDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetClassificationDefByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the Entity definition for the given GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetEntityDefinitionByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEntityDefinitionByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntityDefinitionByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the Entity definition for the given GUID. + /// The globally unique identifier of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetEntityDefinitionByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEntityDefinitionByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntityDefinitionByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the entity definition by its name (unique). + /// The name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetEntityDefinitionByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEntityDefinitionByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntityDefinitionByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the entity definition by its name (unique). + /// The name of the entity. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetEntityDefinitionByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEntityDefinitionByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEntityDefinitionByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the enum definition for the given GUID. + /// The globally unique identifier of the enum. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetEnumDefByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEnumDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEnumDefByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the enum definition for the given GUID. + /// The globally unique identifier of the enum. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetEnumDefByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEnumDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEnumDefByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the enum definition by its name (unique). + /// The name of the enum. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetEnumDefByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEnumDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEnumDefByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the enum definition by its name (unique). + /// The name of the enum. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetEnumDefByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetEnumDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetEnumDefByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the relationship definition for the given GUID. + /// The globally unique identifier of the relationship. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetRelationshipDefByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetRelationshipDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelationshipDefByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the relationship definition for the given GUID. + /// The globally unique identifier of the relationship. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetRelationshipDefByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetRelationshipDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelationshipDefByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the relationship definition by its name (unique). + /// The name of the relationship. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetRelationshipDefByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetRelationshipDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelationshipDefByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the relationship definition by its name (unique). + /// The name of the relationship. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetRelationshipDefByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetRelationshipDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetRelationshipDefByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the struct definition for the given GUID. + /// The globally unique identifier of the struct. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetStructDefByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetStructDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStructDefByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the struct definition for the given GUID. + /// The globally unique identifier of the struct. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetStructDefByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetStructDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStructDefByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the struct definition by its name (unique). + /// The name of the struct. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetStructDefByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetStructDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStructDefByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the struct definition by its name (unique). + /// The name of the struct. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetStructDefByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetStructDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStructDefByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the type definition for the given GUID. + /// The globally unique identifier of the type. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetTypeDefinitionByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTypeDefinitionByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTypeDefinitionByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the type definition for the given GUID. + /// The globally unique identifier of the type. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetTypeDefinitionByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTypeDefinitionByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTypeDefinitionByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the type definition by its name (unique). + /// The name of the type. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetTypeDefinitionByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTypeDefinitionByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTypeDefinitionByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the type definition by its name (unique). + /// The name of the type. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetTypeDefinitionByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTypeDefinitionByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTypeDefinitionByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete API for type identified by its name. + /// The name of the type. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteTypeByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.DeleteTypeByName"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTypeByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete API for type identified by its name. + /// The name of the type. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteTypeByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.DeleteTypeByName"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTypeByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all type definitions in Atlas in bulk. + /// + /// Whether include termtemplatedef when return all typedefs. + /// This is always true when search filter type=term_template + /// + /// Typedef name as search filter when get typedefs. Allowed values: "enum" | "entity" | "classification" | "relationship" | "struct" | "term_template". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetAllTypeDefinitionsAsync(bool? includeTermTemplate = null, string type = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetAllTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAllTypeDefinitionsRequest(includeTermTemplate, type, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get all type definitions in Atlas in bulk. + /// + /// Whether include termtemplatedef when return all typedefs. + /// This is always true when search filter type=term_template + /// + /// Typedef name as search filter when get typedefs. Allowed values: "enum" | "entity" | "classification" | "relationship" | "struct" | "term_template". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetAllTypeDefinitions(bool? includeTermTemplate = null, string type = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetAllTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAllTypeDefinitionsRequest(includeTermTemplate, type, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Create all atlas type definitions in bulk, only new definitions will be created. + /// Any changes to the existing definitions will be discarded. + /// + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task CreateTypeDefinitionsAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.CreateTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateTypeDefinitionsRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Create all atlas type definitions in bulk, only new definitions will be created. + /// Any changes to the existing definitions will be discarded. + /// + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response CreateTypeDefinitions(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.CreateTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateTypeDefinitionsRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update all types in bulk, changes detected in the type definitions would be persisted. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task UpdateAtlasTypeDefinitionsAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.UpdateAtlasTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateAtlasTypeDefinitionsRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Update all types in bulk, changes detected in the type definitions would be persisted. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response UpdateAtlasTypeDefinitions(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.UpdateAtlasTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateUpdateAtlasTypeDefinitionsRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete API for all types in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteTypeDefinitionsAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.DeleteTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTypeDefinitionsRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Delete API for all types in bulk. + /// The content to send as the body of the request. Details of the request body schema are in the Remarks section below. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response DeleteTypeDefinitions(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.DeleteTypeDefinitions"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteTypeDefinitionsRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List all type definitions returned as a list of minimal information header. + /// + /// Whether include termtemplatedef when return all typedefs. + /// This is always true when search filter type=term_template + /// + /// Typedef name as search filter when get typedefs. Allowed values: "enum" | "entity" | "classification" | "relationship" | "struct" | "term_template". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetTypeDefinitionHeadersAsync(bool? includeTermTemplate = null, string type = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTypeDefinitionHeaders"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTypeDefinitionHeadersRequest(includeTermTemplate, type, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List all type definitions returned as a list of minimal information header. + /// + /// Whether include termtemplatedef when return all typedefs. + /// This is always true when search filter type=term_template + /// + /// Typedef name as search filter when get typedefs. Allowed values: "enum" | "entity" | "classification" | "relationship" | "struct" | "term_template". + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetTypeDefinitionHeaders(bool? includeTermTemplate = null, string type = null, RequestContext context = null) + { + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTypeDefinitionHeaders"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTypeDefinitionHeadersRequest(includeTermTemplate, type, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the term template definition for the given GUID. + /// The globally unique identifier of the term template. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetTermTemplateDefByGuidAsync(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTermTemplateDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTermTemplateDefByGuidRequest(guid, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the term template definition for the given GUID. + /// The globally unique identifier of the term template. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetTermTemplateDefByGuid(string guid, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(guid, nameof(guid)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTermTemplateDefByGuid"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTermTemplateDefByGuidRequest(guid, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the term template definition by its name (unique). + /// The name of the term template. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual async Task GetTermTemplateDefByNameAsync(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTermTemplateDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTermTemplateDefByNameRequest(name, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Get the term template definition by its name (unique). + /// The name of the term template. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. Details of the response body schema are in the Remarks section below. + /// + public virtual Response GetTermTemplateDefByName(string name, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(name, nameof(name)); + + using var scope = ClientDiagnostics.CreateScope("TypesClient.GetTermTemplateDefByName"); + scope.Start(); + try + { + using HttpMessage message = CreateGetTermTemplateDefByNameRequest(name, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetBusinessMetadataDefByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/businessmetadatadef/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetBusinessMetadataDefByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/businessmetadatadef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetClassificationDefByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/classificationdef/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetClassificationDefByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/classificationdef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetEntityDefinitionByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/entitydef/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetEntityDefinitionByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/entitydef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetEnumDefByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/enumdef/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetEnumDefByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/enumdef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetRelationshipDefByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/relationshipdef/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetRelationshipDefByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/relationshipdef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetStructDefByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/structdef/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetStructDefByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/structdef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetTypeDefinitionByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedef/guid/", false); + uri.AppendPath(guid, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetTypeDefinitionByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateDeleteTypeByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedef/name/", false); + uri.AppendPath(name, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetAllTypeDefinitionsRequest(bool? includeTermTemplate, string type, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedefs", false); + if (includeTermTemplate != null) + { + uri.AppendQuery("includeTermTemplate", includeTermTemplate.Value, true); + } + if (type != null) + { + uri.AppendQuery("type", type, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateTypeDefinitionsRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedefs", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateUpdateAtlasTypeDefinitionsRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedefs", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteTypeDefinitionsRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedefs", false); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetTypeDefinitionHeadersRequest(bool? includeTermTemplate, string type, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/atlas/v2/types/typedefs/headers", false); + if (includeTermTemplate != null) + { + uri.AppendQuery("includeTermTemplate", includeTermTemplate.Value, true); + } + if (type != null) + { + uri.AppendQuery("type", type, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetTermTemplateDefByGuidRequest(string guid, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/types/termtemplatedef/guid/", false); + uri.AppendPath(guid, true); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetTermTemplateDefByNameRequest(string name, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.AppendRaw(_endpoint, false); + uri.AppendRaw("/catalog/api", false); + uri.AppendPath("/types/termtemplatedef/name/", false); + uri.AppendPath(name, true); + uri.AppendQuery("api-version", "2022-03-01-preview", true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier204; + private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); + } +} diff --git a/sdk/purview/Azure.Analytics.Purview.Account/src/autorest.md b/sdk/purview/Azure.Analytics.Purview.Account/src/autorest.md index 45ccf1bbc0bc..e96af4e879cc 100644 --- a/sdk/purview/Azure.Analytics.Purview.Account/src/autorest.md +++ b/sdk/purview/Azure.Analytics.Purview.Account/src/autorest.md @@ -4,7 +4,9 @@ Run `dotnet build /t:GenerateCode` to generate code. ```yaml title: PurviewAccount -input-file: https://github.com/Azure/azure-rest-api-specs/blob/b2bddfe2e59b5b14e559e0433b6e6d057bcff95d/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json +require: +- /mnt/vss/_work/1/s/azure-rest-api-specs/specification/purview/data-plane/readme.md + namespace: Azure.Analytics.Purview.Account security: AADToken security-scopes: https://purview.azure.net/.default @@ -57,3 +59,4 @@ directive: $.operationId = (mappingTable[$.operationId] ?? $.operationId); ``` +